Mysaa/Encartes-backend
1
0
Fork 0
mirror of https://gitlab.aliens-lyon.fr/encartes/backend.git synced 2026-03-17 22:51:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added Readme so Basile can install <3

Browse Source
This commit is contained in:
Mysaa 2023-01-18 14:45:35 +01:00
parent 145f4aa7fd
commit 76041c09ba
Signed by: Mysaa
GPG Key ID: 7054D5D6A90F084F
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md Normal file
View File

@ -0,0 +1,33 @@
ENcarteS Backend
===
ENcarteS is a software that allows one to get/edit information about one room, to find it on a map, and to make api calls to get those informations.
You are currently viewing at the backend part of the software, that is the part that will persistently store room data and that will serve it through an url API.
## Implementation
## Known issues
## Install locally
In order to run a test version of the software, you will first have to install some programs.
The project backend is made with symfony 6.2. You will have to install the following depedencies:
- PHP 8.2 (You can get a packaged version [on sury's website](https://deb.sury.org/)
- PHP packages: mbstring, intl, xml, and psql (debian packages are php8.2-mbstring, php8.2-intl, php8.2-xml, php8.2-pgsql)
- A PostgreSQL server (debian package postgresql)
- Symfony client (you can download it on [symfony's website](https://symfony.com/download))
- Composer (go to [composer webpage](symfony check:requirements))
You should be able to run the command `symfony check:requirements`. This command should tell you that everything is good. If some package is not installed ... well, you should do so.
Then, you can clone the repo in some folder (you have to install git), `cd` into that folder. Now, you can make composer install all depedencies with `composer install`. If you have not created the database yet, you should create an user `encartes` that can authenticate from localhost with some password. This password should be given in the file `config/packages/doctrine.yaml` (direct configuration files should be removed in future updates). Once all has been set up, you can create the base database with command `php bin/console doctrine:database:create` and you can setup the tables to the latest layout with `php bin/console doctrine:migrations:migrate`.
Your installation should be complete, you can run `symfony local:server:start` to start the server locally (usually on *127.0.0.1:8000*).
## Todolist
- [x] Make the base project
- [ ] Hide password from configfile using symfony vaults
- [ ] (Automatic) API documentation