Contributing

If you like this application and want it to improve, feel free to contribute to its development.

Contribution List

If you help bring this project forward you deserve to be credited for it. Feel free to add yourself to CONTRIBUTERS.md or message me to add you if you have contributed anything.

Issues

The most basic but also very important way of contributing is reporting issues and commenting on ideas and feature requests over at GitHub issues.

Without feedback improvement can't happen, so don't hesitate to say what you want to say.

Contributing Code

If you want to contribute bug fixes or small tweaks then your pull requests are always welcome!

Discuss First!

If you want to contribute larger features that introduce more complexity to the project please make sure to first submit a technical description outlining what and how you want to do it. This allows me and the community to give feedback and manage the complexity of the overall application. If you don't do this please don't be mad if I reject your PR

Info

The dev setup is a little messy as this application combines the best (at least in my opinion) of both Django and Vue.js.

Django

This application is developed using the Django framework for Python. They have excellent documentation on how to get started, so I will only give you the basics here.

1. Clone this repository wherever you like and install the Python language for your OS (I recommend using version 3.10 or above).
2. Open it in your favorite editor/IDE (e.g. PyCharm). a. If you want, create a virtual environment for all your packages.
3. Install all required packages: pip install -r requirements.txt.
4. Run the migrations: python manage.py migrate.
5. Start the development server: python manage.py runserver.

There is no need to set any environment variables. By default, a simple SQLite database is used and all settings are populated from default values.

Vue.js

Most new frontend pages are build using Vue.js.

In order to work on these pages, you will have to install a Javascript package manager of your choice. The following examples use yarn.

In the vue folder run yarn install to install the dependencies. After that you can use yarn serve to start the development server, and proceed to test your changes. If you do not wish to work on those pages, but instead want the application to work properly during development, run yarn build to build the frontend pages once.

API Client

The API Client is generated automatically from the OpenAPI interface provided by the Django REST framework. For this openapi-generator is used.

Install it using your desired setup method. (For example, using npm install @openapitools/openapi-generator-cli -g.)

Navigate to vue/src/utils/openapi.

Generate the schema using openapi-generator-cli generate -g typescript-axios -i http://127.0.0.1:8000/openapi/. (Replace your dev server url if required.)

Contribute Documentation

The documentation is built from the markdown files in the docs folder of the GitHub repository.

In order to contribute to the documentation, you can fork the repository and edit the markdown files in the browser.

Now install mkdocs and dependencies: pip install mkdocs-material mkdocs-include-markdown-plugin.

If you want to test the documentation, locally run mkdocs serve from the project root.

Contribute Translations

If you know any foreign languages that the project has not been completely translated to yet, feel free to contribute translations.

Translations are managed on translate.tandoor.dev, a self hosted instance of Weblate.

You can simply register an account and then follow these steps to add translations:

1. After registering, you are asked to select your languages. This is optional but allows weblate to only show you relevant translations.
2. In the navigation click on Projects and then Browse all projects.
3. Select Tandoor and on the top-right hand corner, select Watch project Tandoor (click on Not watching).
4. Go back to the dashboard. It now shows you the relevant translations for your languages. Click on the pencil icon to get started.

Creating a new language

To create a new language you must first select Tandoor (the project) and then a component. Here you will have the option to add the language. Afterwards you can also simply add it to the other components as well. Once a new language is (partially) finished let me know on GitHub so I can add it to the language-switcher in Tandoor itself.

There is also a lot of documentation available from Weblate directly.

It is also possible to provide the translations directly by creating a new language using manage.py makemessages -l <language_code> -i venv. Once finished, simply open a PR with the changed files. This sometimes causes issues merging with weblate, so I would prefer the use of weblate.