updated docs and fixed links

This commit is contained in:
vabene1111
2025-08-23 08:49:10 +02:00
parent 6b1217ec35
commit 1d90f8b6f1
4 changed files with 19 additions and 55 deletions

View File

@@ -11,34 +11,14 @@ If you like this application and want it to give back, there are many ways to co
If you know any foreign languages you can: If you know any foreign languages you can:
Improve the translations for any of the existing languages. Improve the translations for any of the existing languages.
Add a new language to the long list of existing translations. See [here](/contribute/translations/) for further information on how to contribute translation to Tandoor.
- Armenian
- Bulgarian
- Catalan
- Czech
- Danish
- Dutch
- English
- French
- German
- Hungarian
- Italian
- Latvian
- Norwegian
- Polish
- Russian
- Spanish
- Swedish
See [here](/docs/contribute/translations) for further information on how to contribute translation to Tandoor.
## Issues and Feature Requests ## Issues and Feature Requests
The most basic but also very important way of contributing is reporting issues and commenting on ideas and feature requests The most basic but also crucial way of contributing is reporting issues and commenting on ideas and feature requests
over at [GitHub issues](https://github.com/vabene1111/recipes/issues). over at [GitHub issues](https://github.com/vabene1111/recipes/issues).
Without feedback improvement can't happen, so don't hesitate to say what you want to say. Without feedback, improvement can't happen, so don't hesitate to say what you want to say.
## Documentation ## Documentation
@@ -46,12 +26,12 @@ Helping improve the documentation for Tandoor is one of the easiest ways to give
You can write guides on how to install and configure Tandoor expanding our repository of non-standard configuations. You can write guides on how to install and configure Tandoor expanding our repository of non-standard configuations.
Or you can write how-to guides using some of Tandoor's advanced features such as authentication or automation. Or you can write how-to guides using some of Tandoor's advanced features such as authentication or automation.
See [here](/docs/contribute/documentation) for more information on how to add documentation to Tandoor. See [here](/contribute/documentation/) for more information on how to add documentation to Tandoor.
## Contributing Code ## Contributing Code
For the truly ambitious, you can help write code to fix issues, add additional features, or write your own scripts using For the truly ambitious, you can help write code to fix issues, add additional features, or write your own scripts using
Tandoor's extensive API and share your work with the community. Tandoor's extensive API and share your work with the community.
Before writing any code, please make sure that you review [contribution guidelines](/docs/contribute/guidelines) and Before writing any code, please make sure that you review [contribution guidelines](/contribute/guidelines/) and
[VSCode](/docs/contribute/vscode) or [PyCharm](/docs/contribute/pycharm) specific configurations. [VSCode](/contribute/vscode) or [PyCharm](/contribute/pycharm) specific configurations.

View File

@@ -32,10 +32,10 @@ To contribute to the project you are required to use the following packages with
## Testing ## Testing
Django uses pytest-django to implement a full suite of testing. If you make any functional changes, please implment the appropriate Django uses pytest-django to implement a full suite of testing. If you make any functional changes, please implement the appropriate
tests. tests.
Tandoor is also actively soliciting contribors willing to setup vue3 testing. If you have knowledge in this area it would be greatly appreciated. Tandoor is also actively soliciting contributors willing to setup vue3 testing. If you have knowledge in this area it would be greatly appreciated.
## API Client ## API Client
@@ -44,9 +44,7 @@ Tandoor is also actively soliciting contribors willing to setup vue3 testing. If
The OpenAPI Generator is a Java project. You must have the java binary executable available on your PATH for this to work. The OpenAPI Generator is a Java project. You must have the java binary executable available on your PATH for this to work.
Tandoor uses [django-rest-framework](https://www.django-rest-framework.org/) for API implementation. Making contributions that impact the API requires an understanding of Tandoor uses [django-rest-framework](https://www.django-rest-framework.org/) for API implementation. Making contributions that impact the API requires an understanding of
Viewsets and Serializers. ViewSets and Serializers.
Also double check that your changes are actively reflected in the schema so that client apis are generated accurately.
The API Client is generated automatically from the OpenAPI interface provided by the Django REST framework. The API Client is generated automatically from the OpenAPI interface provided by the Django REST framework.
For this [openapi-generator](https://github.com/OpenAPITools/openapi-generator) is used. For this [openapi-generator](https://github.com/OpenAPITools/openapi-generator) is used.
@@ -55,17 +53,9 @@ Install it using your desired setup method. (For example, using `npm install @op
### Vue ### Vue
Navigate to `vue/src/utils/openapi`. Generate the schema using the `generate_api_client.py` script in the main directory.
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.)
### Vue3
Navigate to `vue3/src/openapi`.
Generate the schema using `openapi-generator-cli generate -g typescript-fetch -i http://127.0.0.1:8000/openapi/`. (Replace your dev server url if required.)
## Install and Configuration ## Install and Configuration
Instructions for [VSCode](/docs/contribute/vscode) Instructions for [VSCode](/contribute/vscode)
Instructions for [PyCharm](/docs/contribute/pycharm) Instructions for [PyCharm](/contribute/pycharm)

View File

@@ -1,7 +1,5 @@
<!-- prettier-ignore-start -->
!!! info "Development Setup" !!! info "Development Setup"
The dev setup is a little messy as this application combines the best (at least in my opinion) of both Django and Vue.js. The dev setup is a little messy as this application combines the best (at least in my opinion) of both Django and Vue.js.
<!-- prettier-ignore-end -->
### Devcontainer Setup ### Devcontainer Setup
@@ -32,17 +30,15 @@ populated from default values.
### Vue.js ### Vue.js
<!-- prettier-ignore-start --> !!! danger "Development Setup"
!!! warning "Feature Freeze" The vite dev server **must** be started before the django runserver command is run or else django will **not** recognize it and try to fallback to the build files.
With the exception of bug fixes, no changes will be accepted on the legacy `vue` front-end.
<!-- prettier-ignore-end -->
Most new frontend pages are build using [Vue.js](https://vuejs.org/). The frontend is build using [Vue.js](https://vuejs.org/).
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 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` followed by `yarn build` to install and build the legacy front-end. 1. go to the `vue3` and run `yarn install` to install the dependencies
In the `vue3` folder run `yarn install` followed by `yarn build` to install and build the new front-end. 2. run `yarn serve` to start the dev server that allows hot reloading and easy and quick development
After that you can use `yarn serve` from the `vue3` folder 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. After that you
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. might need to run `python manage.py collectstatic` to setup the static files.

View File

@@ -16,8 +16,6 @@ Maintained by [Aimo](https://github.com/aimok04/kitshn)
- Website: [https://kitshn.app/](https://kitshn.app/) - Website: [https://kitshn.app/](https://kitshn.app/)
- Appstores: [Apple](https://apps.apple.com/us/app/kitshn-for-tandoor/id6740168361), [Android](https://play.google.com/store/apps/details?id=de.kitshn.android) - Appstores: [Apple](https://apps.apple.com/us/app/kitshn-for-tandoor/id6740168361), [Android](https://play.google.com/store/apps/details?id=de.kitshn.android)
### Untare (discontinued) ### Untare (discontinued)
Maintained by [phantomate](https://github.com/phantomate/Untare) Maintained by [phantomate](https://github.com/phantomate/Untare)