mirror of
https://github.com/IRBorisov/ConceptPortal.git
synced 2025-06-26 13:00:39 +03:00
149 lines
3.5 KiB
Markdown
149 lines
3.5 KiB
Markdown
# ConceptPortal
|
|
|
|
React + Django based web portal for editing RSForm schemas.
|
|
This readme file is used mostly to document project dependencies
|
|
|
|
# Contributing notes
|
|
|
|
!BEFORE PUSHING INTO MAIN!
|
|
|
|
- use Test config in VSCode to run tests before pushing commits / requests
|
|
- cd rsconcept/frontend & npm run build
|
|
|
|
# Frontend stack & Tooling [Vite + React + Typescript]
|
|
|
|
<details>
|
|
<summary>npm install</summary>
|
|
<pre>
|
|
- axios
|
|
- clsx
|
|
- react-icons
|
|
- react-router-dom
|
|
- react-toastify
|
|
- react-loader-spinner
|
|
- react-tabs
|
|
- react-intl
|
|
- react-select
|
|
- react-error-boundary
|
|
- react-pdf
|
|
- react-tooltip
|
|
- js-file-download
|
|
- framer-motion
|
|
- reagraph
|
|
- @tanstack/react-table
|
|
- @uiw/react-codemirror
|
|
- @uiw/codemirror-themes
|
|
- @lezer/lr
|
|
</pre>
|
|
</details>
|
|
<details>
|
|
<summary>npm install -D</summary>
|
|
<pre>
|
|
- tailwindcss
|
|
- postcss
|
|
- autoprefixer
|
|
- eslint-plugin-simple-import-sort
|
|
- eslint-plugin-tsdoc
|
|
- jest
|
|
- ts-jest
|
|
- @types/jest
|
|
- @lezer/generator
|
|
</pre>
|
|
</details>
|
|
<details>
|
|
<details>
|
|
<summary>Google fonts</summary>
|
|
<pre>
|
|
- Rubik
|
|
- Geologica
|
|
- Noto Sans Math
|
|
</pre>
|
|
</details>
|
|
<summary>VS Code plugins</summary>
|
|
<pre>
|
|
- ESLint
|
|
- Colorize
|
|
- Code Spell Checker (eng + rus)
|
|
- Backticks
|
|
- Svg Preview
|
|
- TODO Highlight v2
|
|
</pre>
|
|
</details>
|
|
|
|
# Backend stack & Tooling [Django + PostgreSQL/SQLite]
|
|
|
|
- [ConceptCore](https://github.com/IRBorisov/ConceptCore)
|
|
<details>
|
|
<summary>requirements</summary>
|
|
<pre>
|
|
- django
|
|
- djangorestframework
|
|
- django-cors-headers
|
|
- django-filter
|
|
- drf-spectacular
|
|
- tzdata
|
|
- gunicorn
|
|
- coreapi
|
|
- psycopg2-binary
|
|
- pymorphy2
|
|
- razdel
|
|
</pre>
|
|
</details>
|
|
<details>
|
|
<summary>requirements_dev</summary>
|
|
<pre>
|
|
- coverage
|
|
- pylint
|
|
- mypy
|
|
- djangorestframework-stubs[compatible-mypy]
|
|
</pre>
|
|
</details>
|
|
<details>
|
|
<summary>VS Code plugins</summary>
|
|
<pre>
|
|
- Pylance
|
|
- Pylint
|
|
- Django
|
|
</pre>
|
|
</details>
|
|
|
|
# DevOps
|
|
|
|
- Docker compose
|
|
- PowerShell
|
|
- Certbot
|
|
- Docker VSCode extension
|
|
|
|
# Developer Notes
|
|
|
|
## Local build (Windows 10+)
|
|
|
|
- this is main developers build
|
|
- Install Python 3.9, 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
|
|
|
|
- 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
|
|
|
|
- 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
|
|
|
|
- provide secrets: 'secrets/db_password.txt' and 'django_key.txt'
|
|
- setup domain names for application and API in configs: 'frontend\env\.env.production', 'rsconcept\backend\.env.dev', 'nginx\production.conf'
|
|
- provide privacy policy document in PDF: 'frontend/public/privacy.pdf'
|
|
- use certbot to obtain certificates via 'docker compose -f "docker-compose-prod.yml" run --rm certbot certonly --webroot --webroot-path /var/www/certbot/ -d portal.acconcept.ru api.portal.acconcept.ru'
|
|
- run via 'docker compose -f "docker-compose-prod.yml" up --build -d'
|
|
- update via 'bash scripts/prod/UpdateProd.sh'
|