https://github.com/ssysm/restcms

A Lightweight, RESTful API CMS system
https://github.com/ssysm/restcms

cms cms-framework rest-api rest-cms

Last synced: about 1 year ago
JSON representation

A Lightweight, RESTful API CMS system

• Host: GitHub
• URL: https://github.com/ssysm/restcms
• Owner: ssysm
• License: gpl-3.0
• Created: 2018-02-11T04:17:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-18T03:00:09.000Z (about 8 years ago)
• Last Synced: 2025-02-18T08:55:08.264Z (over 1 year ago)
• Topics: cms, cms-framework, rest-api, rest-cms
• Language: JavaScript
• Homepage: https://restcms.tes-project.xyz
• Size: 185 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# REST CMS

A Lightweight, Simple, RESTful API CMS system

## Setup

## Dependencies

   - MongoDB v3.4+

   - NodeJS v9.3.0+

   

### Configuration

   - Copy `config.js.example` to `config.js` 

   - Edit `config.js`

        - `database`:MongoDB Connection URI, default:`mongodb://localhost:27017/restcms`

        - `jwtSecret`:Secret for JWT Token, default:`restcms` **HIGHLY RECOMMEND TO CHANGE THIS DUE TO SECURITY ISSUE!**

   - `npm install`

   - `node migrate.js`

       - Default admin username:`admin`

       - Default admin password:`password`

### Run

   

#### Run API Server

   (No `npm install`,assume you did everything in [Configuration](#configuration))

   

    $ npm run start

    

API Server Listen @ port `3000` (Port can be changed in `/bin/www`)

#### Compile API Documentation

    $ cd docs

    $ npm install

    $ npm run build

    

Compiled API Documentation @ `/docs/index.html`