mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
0bace3f3af
* moved docker files to /contrib/container * changed code owners to make more precise * updated CI to use new subdirs * added manual trigger for testing * moved ci files * moved assets into subdir * moved deploy template file to contrib * moved django files to src/backend * updated paths in scripts etc * updated reqs path * fixed version file path * fixed flake8 path * fixed path to node ressources * fixed task paths * added dep path for node * removed unused yarn lockfile * removed unused ci script * updated internal backend paths for tasks * updated translation stats path * fixed source path for coverage * fixed main commit repo path * fit in changes from testing * gather packager improvements (#149) * Matmair/issue5578 (#143) * moved docker files to /contrib/container * changed code owners to make more precise * updated CI to use new subdirs * added manual trigger for testing * moved ci files * moved assets into subdir * moved deploy template file to contrib * moved django files to src/backend * updated paths in scripts etc * updated reqs path * fixed version file path * fixed flake8 path * fixed path to node ressources * fixed task paths * added dep path for node * removed unused yarn lockfile * removed unused ci script * updated internal backend paths for tasks * updated translation stats path * fixed source path for coverage * fixed main commit repo path * fix docker path * use project dir * move project dir command * fixed docker paths * another fix? * seperate tasks out * remove tasks * some debugging * ci: add .deepsource.toml * Update .deepsource.toml * also ignore migrations * more debugging * fix path issues * remove debug script * fix style * change locale path * Fixed paths for requirements * Added dummy requirements to fool packager * fixed exec path * remove deepsource --------- Co-authored-by: deepsource-io[bot] <42547082+deepsource-io[bot]@users.noreply.github.com> * Added docs for file structure * Fixed style errors * updated deepsource paths * fix deepsource paths * fixed reqs * merge fixes * move newly added dirs too * fix reqs files * another dep fix * merge upstream/master * revert removal of tags * merge upstream * enabled detection of old config files * adapt coverage src * also detect and support old location for plugins.txt * style fix * fix ~/init.sh location * fix requirements path * fix config to current master * move new folders * fix import order * fix paths for qc_check * fix docs build * fix fix path * set docker project dir * just use a cd * set image path? * set file correct * fix copy path * fix tasks dir * fix init path * fix copy path * set prject dir * fix paths * remove old prod files * fix dev env path * set docker file * Fix devcontainer docker compose file * fix login attempt values * fix init.sh path * Fix pathing for Docker * Docker build fix - Set INVENTREE_BACKEND_DIR separately * Update init.sh * Fix path * Update requirements.txt * merge * fix rq merge * fix docker compose usage --------- Co-authored-by: deepsource-io[bot] <42547082+deepsource-io[bot]@users.noreply.github.com> Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
51 lines
3.3 KiB
Markdown
51 lines
3.3 KiB
Markdown
### Contributing to InvenTree
|
|
|
|
Hi there, thank you for your interest in contributing!
|
|
Please read our contribution guidelines, before submitting your first pull request to the InvenTree codebase.
|
|
|
|
### Project File Structure
|
|
|
|
The InvenTree project is split into two main components: frontend and backend. This source is located in the `src` directory. All other files are used for project management, documentation, and testing.
|
|
|
|
```bash
|
|
InvenTree/
|
|
├─ .devops/ # Files for Azure DevOps
|
|
├─ .github/ # Files for GitHub
|
|
│ ├─ actions/ # Reused actions
|
|
│ ├─ ISSUE_TEMPLATE/ # Templates for issues and pull requests
|
|
│ ├─ workflows/ # CI/CD flows
|
|
│ ├─ scripts/ # CI scripts
|
|
├─ .vscode/ # Settings for Visual Code IDE
|
|
├─ assets/ # General project assets
|
|
├─ contrib/ # Files needed for deployments
|
|
│ ├─ container/ # Files related to building container images
|
|
│ ├─ installer/ # Files needed to build single-file installer
|
|
│ ├─ packager.io/ # Files needed for Debian/Ubuntu packages
|
|
├─ docs/ # Directory for documentation / General helper files
|
|
│ ├─ ci/ # CI for documentation
|
|
│ ├─ docs/ # Source for documentation
|
|
├─ src/ # Source for application
|
|
│ ├─ backend/ # Directory for backend parts
|
|
│ │ ├─ InvenTree/ # Source for backend
|
|
│ │ ├─ requirements.txt # Dependencies for backend
|
|
│ │ ├─ package.json # Dependencies for backend HTML linting
|
|
│ ├─ frontend/ # Directory for frontend parts
|
|
│ │ ├─ src/ # Source for frontend
|
|
│ │ │ ├─ main.tsx # Entry point for frontend
|
|
│ │ ├─ tests/ # Tests for frontend
|
|
│ │ ├─ netlify.toml # Settings for frontend previews (Netlify)
|
|
│ │ ├─ package.json # Dependencies for frontend
|
|
│ │ ├─ playwright.config.ts # Settings for frontend tests
|
|
│ │ ├─ tsconfig.json # Settings for frontend compilation
|
|
├─ .pkgr.yml # Build definition for Debian/Ubuntu packages
|
|
├─ .pre-commit-config.yaml # Code formatter/linter configuration
|
|
├─ CONTRIBUTING.md # Contirbution guidelines and overview
|
|
├─ Procfile # Process definition for Debian/Ubuntu packages
|
|
├─ README.md # General project information and overview
|
|
├─ runtime.txt # Python runtime settings for Debian/Ubuntu packages build
|
|
├─ SECURITY.md # Project security policy
|
|
├─ tasks.py # Action definitions for development, testing and deployment
|
|
```
|
|
|
|
Refer to our [contribution guidelines](https://docs.inventree.org/en/latest/develop/contributing/) for more information!
|