botson_api

The official API of the BotsOn platform made by @5CYTH3 & @Nirbose.

Install & Contribute

The project uses prisma. To connect prisma to your running database, you have to add a DATABASE_URL key in a .env file :

DATABASE_URL="postgresql://username:password@localhost:5432/mydb?schema=public"

(Just remember that you need to replace username, password and mydb by the corresponding values. And IF YOU ARE USING DOCKER TO CONTAINERIZE BOTH THE APP AND THE DATABASE, REPLACE localhost BY postgres)

With Docker

If you are willing to use docker for this project, you need docker and docker-compose installed. In the project directory, run :

pnpm i
docker compose up -d

Docker will retrieve all dependencies and the database automatically. You can also develop inside a container, which is recommended to avoid any "it works on my machine" and to work on a clean environment. To do so, just attach your favourite IDE to the running container.

Without Docker

If you are willing to contribute to the project by forking it and cloning it on your local machine, just run :

pnpm i
pnpm run start:dev

(you will need PostgresSQL running on your machine, either locally or with a docker container).

Sync your fork with upstream

Those commands will save your life.

git fetch upstream
git merge upstream/dev