rzmk/learnhouse
1
0
Fork 0
mirror of https://github.com/rzmk/learnhouse.git synced 2025-12-19 04:19:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #334 from chrishollandaise/chore/update-contributing

Browse source 
chore: fix stale dev doc links, add docker disclaimer
This commit is contained in:
Badr B. 2024-10-13 16:12:30 +02:00 • committed by GitHub
commit dd6f6b11b9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -14,9 +14,11 @@
Use the Docker Image available in `./Dockerfile`
> Make sure your container runtime has at least 4GB of RAM allocated, as default settings may vary by tool.
docker-compose up -d
Initiate a dev environment, please check the official guide [here](https://docs.learnhouse.app/technical-docs/dev-env)
Initiate a dev environment, please check the official guide [here](https://docs.learnhouse.app/setup-dev-environment)
## Frontend Codebase
@ -36,11 +38,11 @@ Use the Docker Image available in `front/Dockerfile`, or install the frontend pa
#### Start the Backend server first
You need to have the backend running, to initiate a dev environment please check the official guide [here](https://docs.learnhouse.app/technical-docs/dev-env)
You need to have the backend running, to initiate a dev environment please check the official guide [here](https://docs.learnhouse.app/setup-dev-environment)
#### Environment Files
Please check if you initiated your `.env` files, here is a [guide](https://docs.learnhouse.app/technical-docs/dev-env) on how to do it.
Please check if you initiated your `.env` files, here is a [guide](https://docs.learnhouse.app/setup-dev-environment) on how to do it.
#### Install the frontend package