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