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