An open API service indexing awesome lists of open source software.

https://github.com/siddhesh321995/cmsone-api

CMS One API Code base
https://github.com/siddhesh321995/cmsone-api

api cms nodejs

Last synced: 2 months ago
JSON representation

CMS One API Code base

Awesome Lists containing this project

README

          

# CMS One API
> Simple light weight node-express based API wrapper

[![Build Status](https://travis-ci.com/siddhesh321995/cmsone-api.svg?branch=master)](https://travis-ci.com/siddhesh321995/cmsone-api)
![Node.js CI](https://github.com/siddhesh321995/cmsone-api/workflows/Node.js%20CI/badge.svg?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/siddhesh321995/cmsone-api/badge.svg?branch=master)](https://coveralls.io/github/siddhesh321995/cmsone-api?branch=master)

## Installation:
- Add auth.json with any authkey at data/ folder. (this key will be used while configuring CMS from GUI)
- Add emails.json with noreply email and noreplyName title at root directory. (Open sample emails.json for ref)

```
npm install cmsone-api --save
```

Setup your API
```
const express = require('express');
const app = express();
const { Main } = require('cmsone-api');

Main.setup(app, {
production: {
MONGODB_CONNECTION: 'mongodb+srv://XXXX:XXXX@XXXX-XXXX.mongodb.net/XXXX',
HAS_CERT: false,
DATABASE_NAME: 'XXXX',
EMAILID: 'XXXX@gmail.com',
EMAIL_PASSWORD: 'password'
}
});
```

## Features:
- Works with express.js and mongo as database.
- Provides basic APIs like Admin, Tracker, Analysis, NewsLetters etc.
- Easily extend by writing your APIs
- Works best with CMS One website (fronend helper for your CMS)