How to contribute

We're very happy about any contributions to Tenta! ✨

Development setup

Server

• Clone the repository and switch into the server directory
• Install the Python version noted in .python-version (e.g. with pyenv)
• Install the poetry package manager (opens in a new tab)
• Install the dependencies with ./scripts/setup
• Make sure that you have Docker installed
• Start the server in development mode with ./scripts/develop; This automatically spins up local PostgreSQL and Mosquitto instances with Docker; The server will be available at http://localhost:8421
• You can run the tests with ./scripts/test and format and lint the code with ./scripts/check

Dashboard

• Start the server in development mode, as described above
• Switch into the dashboard directory
• Have NodeJS (opens in a new tab) version >= 16 installed on your machine
• Install the dependencies with npm install
• Start the dashboard in development mode with npm run dev; Use the username happy-un1c0rn and the password 12345678 to log in
• You can modify .env.development to point your development frontend to a different server
• The directory structure is explained by NextJS (opens in a new tab) (version 13, app router)

Documentation

• Clone the repository and switch into the docs directory
• Have NodeJS (opens in a new tab) version >= 16 installed on your machine
• Install the dependencies with npm install
• Start the documentation in development mode with npm run dev
• The docs are built using Nextra (opens in a new tab) which is again based on NextJS (opens in a new tab)

Making a pull request

You can create a draft pull request if your contribution is not yet ready to merge. Please check if your changes call for updates to the documentation! Changes to the server should be accompanied by tests.