Skip to content
CodeX documentation engine
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Move testing to 3001 port (#8) Oct 7, 2018
config
public
src
test
.codexdocsrc.sample add meta description (#88) Apr 2, 2019
.editorconfig Page model (#1) Aug 17, 2018
.eslintignore Frontent build system is ready (#3) Sep 7, 2018
.eslintrc
.gitignore
.nvmrc Add nvmrc (#2) Sep 3, 2018
README.md Authentication (#22) Mar 6, 2019
generatePassword.js Authentication (#22) Mar 6, 2019
nodemon.json
package.json
webpack.config.js Update Editor and Tools (#56) Mar 8, 2019
yarn.lock Upgrade editor and tools (#89) Apr 7, 2019

README.md

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

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

Install npm packages

$ yarn install --frozen-lockfile

Available scripts

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.

You can’t perform that action at this time.