Bared NPM | npm.io

Lightweight, headless CMS fromework for NodeJS

Quick Start

Installation -> npm install @bared/core

File Structure, see demoApp folder as an example, we only support mysql for now, databases supported by knex should be supported in the future

const Bared = require('@bared/core')
const WechatLogin = require('@bared/plugin-wechat-login')

async function startServer () {
  await Bared({
    databaseConfig: {},
    plugins: [
      WechatLogin(),
    ],
    schemas: [],
    routers: []
  })
}

startServer()

Admin Panel

You can go to public admin panel site here: https://cms.baredigit.com or build your own admin panel.

Clone Admin panel here: https://github.com/baredigit/bared-admin

cd bared-admin

npm install // or yarn
npm start // or yarn

API endpoint is set when you login, for example default API expose -> http://localhost:9293

Progress

Inspired by strapi (https://strapi.io/) but want to be more lightweighted and mobile friendly, developer friendly.

Connect mysql database
Use knex to dynamicly create databases / tables
Better folder structure
Services, routes for DAPI (developer api, CRUD operations)
Basic auth process
Register routes for application developers
Policy management, config application router policy in router config file.
Basic developer dashboard frontend (WIP)
Basic register process
Alert column if anything changed in schema file
- required and default is editable
- type and unique need migration and TBD
Error logging in database
Plugin system
- Defined basic layout of plugin files and exports
- Write email plugin and register from main library
- Research to see if there are good ways to add custom plugin page in admin panel
Joins / Relation fields
3rd party auth (wechat)
Expose config outside (CORS or some other configs)
Basic server security check

Built-in queries in Bared CMS

Default services are bound into koa ctx, and you can use following services directly anywhere in your application:
- get - ctx.queries.get("user", { id: 1 })
- getList - ctx.queries.getList("user")
- create - ctx.queries.create("user", { name: "" })
- update - ctx.queries.update("user", 1, { name: "" })
- count - ctx.queries.count("user")
- delete - ctx.queries.delete("user", { id: 1 })
- upsert - ctx.queries.upsert("user", { id: 1 }, { name: "" })

API category:

/api for enduser, public API, all users can access /papi for enduser, private API, need to login (with authorization header "Bearer xxxxx") /dapi for developer, general CURD operations