learnhouse/docs
1
0
Fork 0
mirror of https://github.com/learnhouse/docs.git synced 2026-02-18 00:07:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: container disclaimer, add missing env for smooth setup

Browse Source
This commit is contained in:
Chris Holland
2024-10-11 10:50:18 -07:00
parent fbc83af39b
commit 57073bd822
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
pages/setup-dev-environment.mdx
View File

@@ -30,6 +30,11 @@ cd learnhouse
### Build & install LearnHouse
<Callout type="warning">
Make sure your container runtime has at least 4GB of RAM allocated, as default
settings may vary by tool.
</Callout>
This will build & run the backend and the database docker images
```shell copy
@@ -70,7 +75,10 @@ poetry install
poetry run python app.py
```
<Callout type="info">To learn more about Configuration options, please refer to the [Configuration](/self-hosting/configuration) documentation</Callout>
<Callout type="info">
To learn more about Configuration options, please refer to the
[Configuration](/self-hosting/configuration) documentation
</Callout>
#### Check the API
@@ -104,12 +112,16 @@ NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=test
NEXT_PUBLIC_LEARNHOUSE_API_URL=http://localhost:1338/api/v1/
NEXT_PUBLIC_LEARNHOUSE_BACKEND_URL=http://localhost:1338/
NEXT_PUBLIC_LEARNHOUSE_DOMAIN=localhost:3000
NEXT_PUBLIC_LEARNHOUSE_TOP_DOMAIN=localhost
```
<Callout type="warning">Setting MultiOrg to true won't work locally for now, please set it to false</Callout>
<Callout type="warning">
Setting MultiOrg to true won't work locally for now, please set it to false
</Callout>
<Callout type="info">
To learn about Organizations Hosting modes, please refer to the [Organization Hosting Modes](/self-hosting/organization-hosting-modes) documentation
To learn about Organizations Hosting modes, please refer to the [Organization
Hosting Modes](/self-hosting/organization-hosting-modes) documentation
</Callout>
Run the dev environment
@@ -128,10 +140,11 @@ NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=default
NEXT_PUBLIC_LEARNHOUSE_API_URL=http://localhost:1338/api/v1/
NEXT_PUBLIC_LEARNHOUSE_BACKEND_URL=http://localhost:1338/
NEXT_PUBLIC_LEARNHOUSE_DOMAIN=localhost:3000
NEXT_PUBLIC_LEARNHOUSE_TOP_DOMAIN=localhost
NEXT_PUBLIC_LEARNHOUSE_COLLABORATION_WS_URL=wss://localhost:1998
```
Make sure to change the `NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG` to the organization you want to set as the default one, you''l find the organization slug in the database in the `organizations` table
Make sure to change the `NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG` to the organization you want to set as the default one, you'll find the organization slug in the database in the `organizations` table
Here it is set to `default` which is the default organization created by the backend when you ran the backend in the previous steps
@@ -143,9 +156,8 @@ Visit the app at [http://localhost:3000/](http://localhost:3000/)
## Next Steps
Thanks for contributing to LearnHouse 💟
Thanks for contributing to LearnHouse 💟
You'll find here some issues/ features we need help with, feel free to contribute to any of them
You'll find here some issues/ features we need help with, feel free to contribute to any of them
- [Help Wanted Issues](https://github.com/learnhouse/learnhouse/labels/help%20wanted)