1
0
Fork 0
mirror of https://github.com/codex-team/codex.docs.git synced 2025-08-07 14:35:26 +02:00

update development docs

This commit is contained in:
Nikita Melnikov 2022-10-02 17:23:45 +08:00
parent 4234a78483
commit d8b03d387a
5 changed files with 36 additions and 2 deletions

2
.gitignore vendored
View file

@ -81,3 +81,5 @@ db/
# Compiled files
/dist/*
/public/dist/*
*.local.yaml

28
DEVELOPMENT.md Normal file
View file

@ -0,0 +1,28 @@
# Development guide
This doc describes how to bootstrap and run the project locally.
## Setup
### 1. Clone the repo.
```shell
git clone https://github.com/codex-team/codex.docs
```
### 2. Install dependencies
```shell
yarn install
```
### 3. Create separate config file for local overrides
```shell
touch app-config.local.yaml
```
### 4. Run the application
```shell
yarn dev
```

View file

@ -66,6 +66,10 @@ docker-compose up
We have the ready-to-use [Helm chart](https://github.com/codex-team/codex.docs.chart) to deploy project in Kubernetes
## Development
See documentation for developers in [DEVELOPMENT.md](./DEVELOPMENT.md).
# About CodeX
<img align="right" width="120" height="120" src="https://codex.so/public/app/img/codex-logo.svg" hspace="50">

View file

@ -24,7 +24,7 @@ hawk:
# backendToken: "123"
database:
driver: mongodb
driver: local # you can change database driver here. 'mongodb' or 'local'
local:
path: ./db
mongodb:

View file

@ -9,7 +9,7 @@
"scripts": {
"start": "concurrently \"yarn start-backend\" \"yarn build-frontend\"",
"dev": "concurrently \"yarn start-backend\" \"yarn build-frontend:dev\"",
"start-backend": "cross-env NODE_ENV=development npx nodemon --config nodemon.json ./src/bin/server.ts",
"start-backend": "cross-env NODE_ENV=development npx nodemon --config nodemon.json ./src/bin/server.ts -c app-config.yaml -c app-config.local.yaml",
"compile": "tsc && copyfiles -u 3 ./src/**/*.twig ./dist/backend/views && copyfiles -u 1 ./src/**/*.svg ./dist/",
"build-frontend": "webpack --mode=production",
"build-frontend:dev": "webpack --mode=development --watch",