diff --git a/README.md b/README.md index 4b207e09..65314e44 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,9 @@ This readme file is used mostly to document project dependencies ## ❤️ 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 -- cd rsconcept/frontend & npm run build +- use github actions to setup linter checks and test builds ## ✨ Frontend [Vite + React + Typescript] @@ -82,7 +81,7 @@ This readme file is used mostly to document project dependencies -## ✨ Backend [Django + PostgreSQL/SQLite] +## 🗃️ Backend [Django + PostgreSQL/SQLite] - [ConceptCore](https://github.com/IRBorisov/ConceptCore)
@@ -119,7 +118,7 @@ This readme file is used mostly to document project dependencies
-## ✨ DevOps +## ⚙️ DevOps - Docker compose - PowerShell @@ -128,29 +127,34 @@ This readme file is used mostly to document project dependencies # 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 - copy import wheels from ConceptCore to rsconcept/backend/import - run rsconcept/backend/LocalEnvSetup.ps1 - 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 - hmr (hot updates) for frontend - run via 'docker compose -f "docker-compose-dev.yml" up --build -d' - 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' - 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' - check if you need to change SSL/TLS and PORT in 'rsconcept\backend\.env.prod'