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