Skip to content

it-collab/api

Repository files navigation

IT Collab API

✍️ About

This is the IT Collab API source code

🛠️ Build and run commands

Make sure you have docker, docker-compose, make and uv installed.

You'll need to specify mode argument with some commands. mode can have 3 values: dev, prod and test depending on app build purpose.

Building a docker container (mode required)

make build

Starting an app (mode required)

make start

Starting the app in background mode (mode required)

make up

Stopping the app (mode required)

make stop

Deleting the docker container (mode required)

make stop

Linting the project

make lint

Running tests

make test

Checking tests coverage

make coverage

Creating a virtual environment locally

make install

Executing bash in docker container

make exec

Creating an alembic revision

make revision

Running the revision

make upgrade revision=<revision identificator>

Downgrading the revision

make downgrade revision=<revision identificator>

🤝 Contributing

The project is closed for open-source contributions

📜 License

Check our license