| .github | ||
| config | ||
| docker | ||
| public | ||
| src | ||
| .codexdocsrc.sample | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.sample | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .nvmrc | ||
| .postcssrc | ||
| docker-compose.yml | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| webpack.config.js | ||
| yarn.lock | ||
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
Setup
You can configure application using configs in /config directory.
port - to set port of application
database - to name directory with data
rcFile - to set destination of rc file
uploads - to set destination of directory to save uploads
secret - to set secret
faviconURL - to set url to get favicon
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 👋 | ||
|---|---|---|---|
| codex.so | codex.so/join | @codex_team | @codex_team |