005c8341bf
* move devcontainer docs * rename bare metal pages * fix backlinks * Add getting started for devs * add mermaid * include contrib in docs * use another plugin * include everything * update doc checks * fix install command * remove mermaid * remove inclusion tag * remove empty list item * readd include-markdown * use non-conflicting syntax for include * fix table rendering in mkdocs * make controbuting embedable * re-add mermaid * remove empty section * resturcture * remove mermaid again
1.6 KiB
title
| title |
|---|
| Getting started |
InvenTree consists of a Django-based backend server, and a HTML / vanilla JS based frontend that uses Bootstrap. The main languages used are Python and Javascript. As part of the larger project other languages/techniques are used, such as docker (dev/deployment), bash (installer) and markdown (documentation).
Getting started
Getting to know the basics
The Django framework is a powerful tool for creating web applications. It is well documented and has a large community. The Django documentation is a good place to start.
In particular the tutorial is a good way to get to know the basics of Django. InvenTree follows the best practies for Django so most of the contents should be applicable to InvenTree as well. The REST API is based on the Django REST framework.
Setting up a development environment
The recommended way to set up a development environment is to use VSCode devcontainers. The required files are provided with the repo, the docs are on a dedicated page.
It is also possible to use docker development or bare metal development. With these you need to install the required dependencies manually with a dedicated task.
invoke setup-dev
Following standards
Before contributing to the project, please read the contributing guidelines. Pull requests that do not follow the guidelines, do not pass QC checks or lower the test coverage will not be accepted.