A Race game developed in one week using React, Styled Components, NodeJS, GraphQL and much fun 🚙 😁

I recommend use NPM or Yarn as package management and install all dependencies using it, running yarn or npm install inside each folder (app and api).

If you have some issues related to permissions, just add the sudo command before yarn/npm command, as sudo yarn.

One important thing before start running this project locally is set up all environment variables. You can set them for back-end creating a .env file on api folder root and following this structure:

  APP_DOMAIN=App Domain with port, probably http://locahost:3000 at this moment.
  MONGODB_USER=MongoDB user (connection)
  MONGODB_PASSWORD=MongoDB password (connection)

You should do the same on front-end, adding an .env file to app folder root:

  REACT_APP_API_URL=Api domain with port, probably http://localhost:3333 running it locally.

To run the project after install all dependecies, you can just run yarn dev or npm run dev (Front-end) and yarn start:dev or npm run start:dev (Back-end).

You can run yarn test inside app folder for Front-end tests. Back-end does not have unit tests yet.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the tags on this repository.

Gabriel Hahn Schaeffer

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details