Manual

Documentation CMS for product / service

Demo

Demo link

Admin:

email: admin@test.com

password: test123

Reader:

email: reader@test.com

password: test123

Prerequisite

• NodeJS 10+
• RethinkDB
• Yarn

Environment setup

See .env.example file

Install packages

yarn

Start app development

yarn dev

Start app

yarn start

Start app (staging)

yarn staging

Start app (production)

yarn production

Usage

1. Go to http://your-domain.com/config.
2. Go to http://your-domain.com/setup to setup default admin account.
3. Go to http://your-domain.com/admin to setup account for admin, editor or reader.
4. Go to http://your-domain.com/manuals to create documentation for product or service.

Goals

• ☑ User management (admin, editor and reader)
• ☑ Manual, Section and Content
• ☑ Searchable (section and content)
• ☑ Intelligent content navigations
• ☑ 100% Responsiveness
• ☐ Document versioning
• ☐ Edit history
• ☐ Docker image
• ☐ AWS marketplace
• ☐ Digital Ocean app

Maintainer

Olalekan Animashaun