mirror of https://github.com/codex-team/codex.docs.git synced 2025-07-24 15:49:42 +02:00

* rm: remove the generate password file

* rm: commander package

* rm: remove the password reading from db

* feat: password hash reading from env added

* passHash replace with password

* raw password comparison added

* rm: user model and controller removed

* update: auth route and token verification

* replace multiple dotenv config with one

* .env.sample added with updated docker yml

* rm:remove the bcrypt

* readme updated with .env

* remove generatePassword from package json

* updated docs

* removed the console.log

2022-04-24 16:54:36 +05:30

3 KiB

Raw Blame History

CodeX Docs

CodeX Docs is a simple but powerful documentation engine for CodeX powered with Editor.js.

You can use CodeX Docs for product documentation, for internal team docs, or for any other documentation.

Development

Prerequisites

NodeJS (v16.x)
npx (installed by default with npm)
Yarn

Install npm packages

yarn install --frozen-lockfile

Create config file

cp .codexdocsrc.sample .codexdocsrc
cp .env.sample .env

Run application (both frontend and backend)

yarn dev

Then you can open browser and navigate to http://localhost:3000.

Now you can authenticate in the application and start creating your documentation.

Available scripts

Start whole application (backend and frontend in watch mode)

yarn dev

Start backend in development mode

yarn start-backend

Compile TypeScript files

yarn compile

Build frontend

To build frontend sources run the following command:

yarn build-frontend

To build frontend and watch for changes run the following command:

yarn build-frontend:dev

Run ESLint with `--fix` option

yarn lint

Run tests

yarn test

Authentication

To manage pages you need to authorize (available on /auth).

To set password, set the PASSWORD environment variable inside the .env file.

Release process

We use release-drafter to generate release notes and GitHub release. It will automatically generate draft release based pull requests data between current version and previous version. To make new release you need go to releases page find the latest draft release and mark it as ready. After creating new release, new git tag will be created and new version will be published.

About CodeX

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 for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.

🌐	Join 👋	Twitter	Instagram
codex.so	codex.so/join	@codex_team	@codex_team

3 KiB Raw Blame History