mirror of
https://github.com/codex-team/codex.docs.git
synced 2025-07-24 23:59:46 +02:00
34514761f5
* Updated highlight.js * Update .codexdocsrc.sample remove undefined page for a fresh new install * backend rewritten in TS * test -> TS, .added dockerignore, bug fixed * Removed compiled js files, eslint codex/ts added * fixed jsdocs warning, leaving editor confirmation * use path.resolve for DB paths * db drives updated + fixed User model * redundant cleared + style fixed * explicit type fixing * fixing testing code * added body block type * compiled JS files -> dist, fixed compiling errors * fixed compiling error, re-organized ts source code * updated Dockerfile * fixed link to parent page * up nodejs version * fix package name * fix deps Co-authored-by: nvc8996 <nvc.8996@gmail.com> Co-authored-by: Taly <vitalik7tv@yandex.ru>
73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
# CodeX Docs
|
|
|
|
Engine for documentation website using [Editor.js](//editorjs.io)
|
|
|
|
|
|
|
|
## Development
|
|
|
|
### Set up the environment
|
|
|
|
Install node version manager and required version of node js
|
|
|
|
```
|
|
$ chmod u+x ./bin/nvm.sh && ./bin/nvm.sh
|
|
$ nvm install
|
|
```
|
|
|
|
> For windows use [nvm for windows](https://github.com/coreybutler/nvm-windows)
|
|
|
|
Install Yarn package manager
|
|
```
|
|
$ brew install yarn --without-node
|
|
```
|
|
|
|
> Use `--without-node` flag because nvm version of Node is used
|
|
|
|
Or download it directly from the [website](https://yarnpkg.com/en/docs/install)
|
|
|
|
### Install npm packages
|
|
|
|
```
|
|
$ yarn install --frozen-lockfile
|
|
```
|
|
|
|
### Available scripts
|
|
#### Compile to Javascript
|
|
```
|
|
$ yarn compile
|
|
```
|
|
|
|
#### Start the server
|
|
|
|
```
|
|
$ yarn start
|
|
```
|
|
|
|
#### Run ESLint with `--fix` option
|
|
|
|
```
|
|
$ yarn lint
|
|
```
|
|
|
|
#### Run tests
|
|
|
|
```
|
|
$ yarn test
|
|
```
|
|
|
|
### Authentication
|
|
|
|
To manage pages you need to authorize (available on `/auth`).
|
|
|
|
To generate password use `yarn generatePassword [password]` command.
|
|
|
|
# About CodeX
|
|
|
|
<img align="right" width="120" height="120" src="https://codex.so/public/app/img/codex-logo.svg" hspace="50">
|
|
|
|
CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are [open](https://codex.so/join) for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.
|
|
|
|
| 🌐 | Join 👋 | Twitter | Instagram |
|
|
| -- | -- | -- | -- |
|
|
| [codex.so](https://codex.so) | [codex.so/join](https://codex.so/join) |[@codex_team](http://twitter.com/codex_team) | [@codex_team](http://instagram.com/codex_team) |
|