RomanNum3ral
/
tubearchivist
mirror of https://github.com/tubearchivist/tubearchivist.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

extend native dev instructions

This commit is contained in:
Simon 2025-01-26 21:57:12 +07:00
parent 4bb34b280f
commit d49d549caa
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -138,11 +138,11 @@ The documentation available at [docs.tubearchivist.com](https://docs.tubearchivi
## Development Environment
I have learned the hard way, that working on a dockerized application outside of docker is very error prone and in general not a good idea. So if you want to test your changes, it's best to run them in a docker testing environment. But for quick development, running the application outside of docker, can also be helpful.
This codebase is set up to be developed natively outside of docker as well as in a docker container. Developing outside of a docker container can be convenient, as IDE and hot reload usually works out of the box. But testing inside of a container is still essential, as there are subtle differences, especially when working with the filesystem and networking between containers.
### Native Instruction
For convenience, it's recommended to still run Redis and ES in a docker container.
For convenience, it's recommended to still run Redis and ES in a docker container. Make sure both containers can be reachable over the network.
Set up your virtual environment and install the requirements defined in `requirements-dev.txt`.
@ -162,14 +162,30 @@ TZ=America/New_York
DJANGO_DEBUG=True
```
Than from look at the container startup script `run.sh`, make sure all needed migrations ran, then to start the dev server from the same folder as `manage.py` run:
Than from look at the container startup script `run.sh`, make sure all needed migrations and startup checks ran, then to start the dev backend server from the same folder as `manage.py` run:
```bash
python manage.py runserver
```
The backend will be available on [localhost:8000/api/](localhost:8000/api/).
You'll probably also want to have a Celery worker instance running, refer to `run.sh` for that. The Beat Scheduler might not be needed.
Then from the frontend folder, install the dependencies with:
```bash
npm install
```
Then to start the developlent server:
```bash
npm run dev
```
And the frontend should be available at [localhost:3000](localhost:3000).
### Docker Instructions
Set up docker on your development machine.