Skip to content
This repository has been archived by the owner on Mar 14, 2023. It is now read-only.

boldr/boldr-api

Repository files navigation

Build Status Build Status codecov Code Climate Commitizen friendly styled with prettier

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.

This repository contains the backend. The backend for Boldr, BoldrAPI, is comprised of a node.js REST API, a Postgres database, and Redis for caching and sessions.

Full documentation can be found at https://docs.boldr.io

Have questions or want to help with development? Join us on

Boldr Repositories

TL;DR Setup Guide

First you must somehow get the files to your machine. Below outlines two options.

Using Boldr-CLI:

   yarn global --add boldr-cli
   boldr-cli init
   cd boldr-api
   yarn
   mv boldrrc.example .boldrrc

Using git:

  git clone git@github.com:boldr/boldr-api.git <DIR_NAME>
  cd <DIR_NAME>
  yarn
  mv boldrrc.example .boldrrc

Service Setup

BoldrAPI requires a Postgres database and a Redis server to connect to. Using the docker-compose.yml file included in the repo is the quickest way.

docker-compose up --build -d starts the necessary services (postgres and redis).

Ensure the database is setup with the proper tables and seed data.
Use the command yarn migrate && yarn seed.

Releases

No releases published

Packages

No packages published

Languages