diff --git a/README.md b/README.md index 4a641613..8b78d887 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ # arcadia-index Arcadia's backend -## Setup +Arcadia is composed of two components: +- The postgres database +- The server -- Copy `.env` to `.env.local` and replace the values with yours +## Developper Setup -- The `docker/` folder contains some containers to various services used by `actix-index`. Feel free to use these or substitutes +### Required tools +- sqlx-cli +- cargo +- docker (recommended) -- Create a database with the name that is specified by the env variable `POSTGRESQL_DATABASE` +### Env +Copy `.env` to `.env.local` -- install `sqlx-cli` and run the database migrations : `sqlx migrate run` +### Database +The recommended method is using docker: +``` +docker-compose -f docker/postgres.yml up -d +sqlx migrate run +``` -## Developing - +### Launch server ``` cargo run -``` \ No newline at end of file +``` + +## Database + +### Creating a migration file +TODO +