Giter Club home page Giter Club logo

atlas's Introduction

Atlas Project

API

The API is building using laravel 10 and php 8.2. It uses phpunit for the test suite.

Frontend

The frontend is built using vue 3, typescript and bootstrap 5. It uses vitest for the test suite.

Setup

  1. Clone the repo git clone [email protected]:joseph-t-martin/atlas.git
  2. Change to the directory cd atlas
  3. Inside the api directory copy the .env.example file to .env cp ./api/.env.example ./api/.env
  4. Add the atlas API key to the .env file
  5. Spin up the docker containers docker-compose up -d

Testing

To Run Frontend tests:
docker-compose exec frontend npm run test:unit

To Run API tests:
docker-compose exec api php /usr/src/api/vendor/phpunit/phpunit/phpunit

Future Improvements

  1. API - Add a caching layer to the API
  2. API - Add more Integration tests to the API
  3. Frontend - Move the API url to an environment variable
  4. Frontend - Add a loading state while waiting for API to return data
  5. Frontend - Increase test coverage for the frontend

atlas's People

Watchers

Joseph Martin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.