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