1![Caroster](./banner.jpg)
  2
  3[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
  4
  5# Caroster - Group carpool to your event
  6
  7Caroster is an easy and free app to organize group carpooling for an event, a party, a seminar, a sports event, a camp, a ski trip…
  8
  9## Getting Started
 10
 11These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
 12
 13Caroster is composed of two parts:
 14
 15- A frontend app based on [NextJS](https://nextjs.org/)
 16- A backend server using [Strapi](https://strapi.io/)
 17
 18### Prerequisites
 19
 20To fully utilize your instance of Caroster, you will need an SMTP configuration to send emails.
 21
 22### Installing
 23
 24Clone the repo locally:
 25
 26```shell
 27git clone https://github.com/octree-gva/caroster.git
 28cd caroster
 29```
 30
 31### Run with Docker
 32
 33```shell
 34docker build -t caroster .
 35cp backend/.env.example backend/.env
 36nano .env # Edit with your own configuration
 37docker run -d -p 80:80 --env-file backend/.env caroster
 38```
 39
 40## Development
 41
 42### Frontend
 43
 44These steps will prepare the frontend to run in development mode.
 45
 46```shell
 47cd frontend
 48yarn # or 'npm install'
 49yarn dev
 50```
 51
 52The frontend is now accessible on http://localhost:3000
 53
 54### Backend
 55
 56These steps will prepare and configure the backend to run in development mode.
 57
 58```shell
 59cd backend
 60yarn # or 'npm install'
 61cp .env.example .env
 62nano .env # Edit with your own configuration
 63yarn develop
 64```
 65
 66The Strapi API is now ready and the admin is accessible on http://localhost:1337/admin.
 67
 68## Running the tests
 69
 70A few tests are available to check GraphQL endpoints behavior in the `e2e` directory.
 71
 72First, run Strapi un test mode:
 73
 74```shell
 75cd backend
 76yarn start-test
 77```
 78
 79Then, run the tests:
 80
 81```shell
 82cd e2e
 83yarn
 84yarn gql
 85yarn test
 86```
 87
 88## Contributing
 89
 90Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 91
 92## Authors
 93
 94- [Octree](https://github.com/octree-gva) - sustainable startup studio - https://octree.ch
 95
 96See also the list of [contributors](https://github.com/octree-gva/caroster/graphs/contributors) who participated in this project.
 97
 98## License
 99
100This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details