ConceptProd/ConceptPortal-public
1
0
Fork 0
mirror of https://github.com/IRBorisov/ConceptPortal.git synced 2025-06-26 04:50:36 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
IRBorisov 2024-05-02 17:14:20 +03:00
parent f68484c834
commit 6f86e457b4
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -15,10 +15,9 @@ This readme file is used mostly to document project dependencies
## ❤️ Contributing notes ## ❤️ Contributing notes
!BEFORE PUSHING INTO MAIN! - feel free to open issues, discussion topics, contact maintainer directly
- use Test config in VSCode to run tests before pushing commits / requests - use Test config in VSCode to run tests before pushing commits / requests
- cd rsconcept/frontend & npm run build - use github actions to setup linter checks and test builds
## ✨ Frontend [Vite + React + Typescript] ## ✨ Frontend [Vite + React + Typescript]
@ -82,7 +81,7 @@ This readme file is used mostly to document project dependencies
</pre> </pre>
</details> </details>
## ✨ Backend [Django + PostgreSQL/SQLite] ## 🗃️ Backend [Django + PostgreSQL/SQLite]
- [ConceptCore](https://github.com/IRBorisov/ConceptCore) - [ConceptCore](https://github.com/IRBorisov/ConceptCore)
<details> <details>
@ -119,7 +118,7 @@ This readme file is used mostly to document project dependencies
</pre> </pre>
</details> </details>
## ✨ DevOps ## ⚙️ DevOps
- Docker compose - Docker compose
- PowerShell - PowerShell
@ -128,29 +127,34 @@ This readme file is used mostly to document project dependencies
# Developer Notes # Developer Notes
## 🔭 Local build (Windows 10+) ## 🖥️ Local build (Windows 10+)
This is the build for local Development
- this is main developers build
- Install Python 3.12, NodeJS, VSCode, Docker Desktop - Install Python 3.12, NodeJS, VSCode, Docker Desktop
- copy import wheels from ConceptCore to rsconcept/backend/import - copy import wheels from ConceptCore to rsconcept/backend/import
- run rsconcept/backend/LocalEnvSetup.ps1 - run rsconcept/backend/LocalEnvSetup.ps1
- use VSCode configs in root folder to start development - use VSCode configs in root folder to start development
## 🔭 Development build ## 🔭 Local docker build
This build does not use HTTPS and nginx for networking
- this build does not use HTTPS and nginx for networking
- backend and frontend debugging is supported - backend and frontend debugging is supported
- hmr (hot updates) for frontend - hmr (hot updates) for frontend
- run via 'docker compose -f "docker-compose-dev.yml" up --build -d' - run via 'docker compose -f "docker-compose-dev.yml" up --build -d'
- populate initial data: 'scripts/dev/PopulateDevData.ps1' - populate initial data: 'scripts/dev/PopulateDevData.ps1'
## Local production build ## 📦 Local production build
This build is same as production except not using production secrets and working on localhost
- this build is same as production except not using production secrets and working on localhost
- provide TLS certificate (can be self-signed) 'nginx/cert/local-cert.pem' and 'nginx/cert/local-key.pem' - provide TLS certificate (can be self-signed) 'nginx/cert/local-cert.pem' and 'nginx/cert/local-key.pem'
- run via 'docker compose -f "docker-compose-prod-local.yml" up --build -d' - run via 'docker compose -f "docker-compose-prod-local.yml" up --build -d'
## 📦 Production build ## 🔥 Production build
This build is deployed on server.
- provide secrets: 'secrets/db_password.txt', 'django_key.txt', 'email_host.txt', 'email_password.txt', 'email_user.txt' - provide secrets: 'secrets/db_password.txt', 'django_key.txt', 'email_host.txt', 'email_password.txt', 'email_user.txt'
- check if you need to change SSL/TLS and PORT in 'rsconcept\backend\.env.prod' - check if you need to change SSL/TLS and PORT in 'rsconcept\backend\.env.prod'