arif-hanif / boldr

React based CMS / blogging engine using Redux, Postgres, Node, and more...

Home Page:https://boldr.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status | codecov | Code Climate

Boldr is a modern content management framework. Think of Boldr as the solid foundation for building your next great web application. Unlike other CMS platforms, Boldr is entirely JavaScript. Boldr features Universal / Isomorphic rendering for improved performance and Search Engine Optimization.

A CLI is in the early development stages. You will be able to scaffold out a complete or partial Boldr project with a single command. Viewable in its repository here

Current Features

  • Full REST API - Giving you the freedom to do whatever you'd like without looking at an interface.
  • Rich text editor / WYSIWYG
  • Server side rendering
  • Authentication with JSON Web Tokens
  • Content tagging - Easily relate content to similar topics
  • Drag and drop file uploading
  • User management with basic role based access control (major expansion of capabilities planned for a later date)
  • Commenting system
  • Basic user and author profiles.
  • Redis caching

Core Technologies

Getting Started / Installation

Development Disclaimer: At the moment, Boldr is in active development. Meaning there might be the occasional breaking changes, and architectural adjustments.

That said, I'm confident the majority of large breaking changes is behind us.

  1. git clone https://github.com/strues/boldr.git
  2. yarn && yarn bootstrap
  3. Modify environment variables cd packages/boldr-api && cp .env_example .env

Usage

Quick notes:

  • Ports
    • API: 2121
    • Frontend: 3000 - React SSR server
    • Webpack: 3001 - dev only

Boldr is configured by default to serve api documentation from http://localhost:3000/apidocs/. The docs are mostly complete and are kept up to date. You can also find them in the docs folder as markdown or view them live at https://staging.boldr.io/apidocs/.

Development

Database

Located in the boldr-api package

The database does not require an initial migration and seed if ran using the provided Docker setup.

Running your own Postgres database? No problem. Create a database and add the connection details to the .env file and package.json. Once you have a fresh database, run the migration command with npm run migrate followed by npm run seed. Your database is now ready to go!

CMS

Run the CMS using npm run dev

After Boldr has started visit http://localhost:3000. The admin account is already created and you may login using these credentials:

Email - admin@boldr.io Password - password

Settings for the build process are located in config/values.js.

API

Production

See the production docs

Screenshots

blog blog2 single
dash files members
post prof settings
tag

Documentation

Demo

View an early demo at https://staging.boldr.io

Email - admin@boldr.io
Password - password

Contributing

Looking for an open source project to contribute to? All types of contributions are welcome here. Take a look at some of the current issues and see if you find something you'd like to help out with. Feel free to submit pull requests to the develop branch.

Contribution Area Ideas

  • Documentation
  • Designs
  • React
  • Node
  • Build / Installation
  • Play a major role in a community driven project, have some fun, and work on improving your skills.

About

React based CMS / blogging engine using Redux, Postgres, Node, and more...

https://boldr.io

License:MIT License


Languages

Language:JavaScript 96.0%Language:CSS 3.9%Language:Makefile 0.1%Language:Shell 0.0%