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> Are you on GitHub ? Please use the [reference repository on GitLab](https://git.octree.ch/p/caroster) for issues and pull requests.
 10
 11## Getting Started
 12
 13These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
 14
 15Caroster is composed of two parts:
 16
 17- A frontend app based on [NextJS](https://nextjs.org/)
 18- A backend server using [Strapi](https://strapi.io/)
 19
 20> Caroster is currently in Beta. Big changes can happen, especially in terms of data architecture.
 21
 22### Prerequisites
 23
 24To fully utilize your instance of Caroster, you will need an SMTP configuration to send emails.
 25
 26### Installing
 27
 28Clone the repo locally:
 29
 30```shell
 31git clone https://git.octree.ch/p/caroster.git
 32cd caroster
 33```
 34
 35### Run with Docker
 36
 37First, create containers with Docker Compose:
 38
 39```shell
 40docker compose up
 41```
 42
 43Wait a few minutes while the application downloads needed packages,
 44then go to http://localhost:8080.
 45
 46You can log on http://localhost:8080/admin with email `admin@example.org`
 47and password `caroster`.
 48
 49## Development
 50
 51### Frontend
 52
 53These steps will prepare the frontend to run in development mode.
 54
 55```shell
 56cd frontend
 57yarn # or 'npm install'
 58yarn dev
 59```
 60
 61The frontend is now accessible on http://localhost:3000
 62
 63### Backend
 64
 65These steps will prepare and configure the backend to run in development mode.
 66
 67```shell
 68cd backend
 69yarn # or 'npm install'
 70cp .env.example .env
 71nano .env # Edit with your own configuration
 72yarn develop
 73```
 74
 75The Strapi API is now ready and the admin is accessible on http://localhost:1337/admin.
 76
 77## Running the tests
 78
 79A few tests are available to check GraphQL endpoints behavior in the `e2e` directory.
 80
 81First, run Strapi un test mode:
 82
 83```shell
 84cd backend
 85yarn start-test
 86```
 87
 88Then, run the tests:
 89
 90```shell
 91cd e2e
 92yarn
 93yarn gql
 94yarn test
 95```
 96
 97## Contributing
 98
 99Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
100
101## Authors
102
103- [Octree](https://github.com/octree-gva) - sustainable startup studio - https://octree.ch
104
105See also the list of [contributors](https://github.com/octree-gva/caroster/graphs/contributors) who participated in this project.
106
107## License
108
109This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details