API web à destination des services de l'UTT Arena
Avant toute chose, prenez connaissance de la documentation.
git clone [email protected]:ungdev/UA-api.git
# or
git clone https://github.com/ungdev/UA-api.git
cd UA-api
# Install all the dependencies
yarn
# Copy the file .env.example to .env
cp .env.example .env
# Then, edit the variable DATABASE_URL in the file .env
Then, connect to your database (MySQL/MariaDB) and enter
CREATE DATABASE arena CHARACTER SET utf8;
Create the tables
yarn prisma db push
Populate the tables
mysql -u DATABASE_USER -p arena --protocol tcp < seed.sql
Generate the prisma client (redo this command when you update schema.prisma)
yarn prisma generate
Edit the file .env with your values
yarn dev # start development server
yarn build # builds the typescript to javascript
yarn start # start production server
yarn lint # checks if the code is correct
yarn lint-fix # try to fix lint errors and warnings
yarn fake # populate the database with fake data
Use npx prisma generate to generate your prisma client
The tests must be able to run without any environment variables except the database
We build the documentation with Sphinx based on markdown. If you want to compile the documentation on your local PC, you will need to have Python 3 and then type the following commands:
cd docs
pip3 install -r requirements.txt
make html
It will create a build folder where the doc is located