README.md

schoolsyst's (next) API

Schoolsyst's next API implementation, built with FastAPI

See documentation at https://beta.api.schoolsyst.com/

Installation

Note A docker image is in the works (the database part is not ready yet)

1. Install Poetry if you don't have it yet.
2. Clone the repository

   git clone https://github.com/schoolsyst/api-next
   

3. Make your .env file and fill it with your values:

   cp .env.example .env
   nano .env
   

4. Install dependencies

   poetry install
   

5. Install ArangoDB (no need if you have docker)
6. Start arangodb

   # with soystemd
   sudo systemctl start arangodb3
   # with systemv
   sudo service arangodb3 start
   # with docker (easier)
   docker run -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD="<your_.env_file's_password>" arangodb/arangodb:3.6.5

7. Test to make sure everything is alright

   make test
   

8. Start it (finally!)

   make dev