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### Run with Docker
30
31```shell
32docker build -t caroster .
33cp backend/.env.example backend/.env
34nano .env # Edit with your own configuration
35docker run -d -p 80:80 --env-file backend/.env caroster
36```
37
38## Development
39
40### Frontend
41
42These steps will prepare the frontend to run in development mode.
43
44```shell
45cd frontend
46yarn # or 'npm install'
47yarn dev
48```
49
50The frontend is now accessible on http://localhost:3000
51
52### Backend
53
54These steps will prepare and configure the backend to run in development mode.
55
56```shell
57cd backend
58yarn # or 'npm install'
59cp .env.example .env
60nano .env # Edit with your own configuration
61yarn develop
62```
63
64The Strapi API is now ready and the admin is accessible on http://localhost:1337/admin.
65
66## Running the tests
67
68A few tests are available to check GraphQL endpoints behavior in the `e2e` directory.
69
70First, run Strapi un test mode:
71
72```shell
73cd backend
74yarn start-test
75```
76
77Then, run the tests:
78
79```shell
80cd e2e
81yarn
82yarn gql
83yarn test
84```
85
86## Contributing
87
88Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
89
90## Authors
91
92- [Octree](https://github.com/octree-gva) - sustainable startup studio - https://octree.ch
93
94See also the list of [contributors](https://github.com/octree-gva/caroster/graphs/contributors) who participated in this project.
95
96## License
97
98This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details