https://github.com/origami-cms/cms

Open source, flexible, and easy to use CMS for Node.js
https://github.com/origami-cms/cms

cms database flexible framework fun node

Last synced: 3 months ago
JSON representation

Open source, flexible, and easy to use CMS for Node.js

• Host: GitHub
• URL: https://github.com/origami-cms/cms
• Owner: origami-cms
• Created: 2017-09-23T05:52:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-20T16:11:29.000Z (almost 6 years ago)
• Last Synced: 2024-04-27T02:27:27.815Z (9 months ago)
• Topics: cms, database, flexible, framework, fun, node
• Language: TypeScript
• Homepage: http://www.origami.so
• Size: 2.08 MB
• Stars: 48
• Watchers: 9
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: contributing.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Origami CMS [Alpha]

The flexible, easy to use, and open-source CMS built for Node.js

![Origami CMS](docs/banner.jpg)

[![Travis](https://img.shields.io/travis/origami-cms/cms.svg?logo=travis)](https://travis-ci.org/origami-cms/cms)

![Codecov branch](https://img.shields.io/codecov/c/github/origami-cms/cms/master.svg)

[![npm](https://img.shields.io/npm/dt/origami-cms.svg)](https://www.npmjs.com/package/origami-cms)

[![GitHub license](https://img.shields.io/github/license/origami-cms/cms.svg)](https://github.com/origami-cms/cms)

[![GitHub issues](https://img.shields.io/github/issues/origami-cms/cms.svg?logo=github&logoColor=white)](https://github.com/origami-cms/cms/issues)

[![GitHub stars](https://img.shields.io/github/stars/origami-cms/cms.svg)](https://github.com/origami-cms/cms/stargazers)

Origami's aim is to be the world's best CMS for the Javascript community. It's built on Node.js and Express with **flexibility as it's primary value**. Use any database, any templating language, any CSS preprocesser (SASS, LESS, etc), and whatever else you'd like to bring to the table. It's a BYO tech stack! It also comes with a bunch of goodies right out of the box.

> **We need your help!**

> Origami is very much a work in progress. To make this platform incredible, we humbly call upon the brilliant minds off the web to collaboratively build the worlds best CMS.

## Getting started

You'll need:

- [Node.js](http://nodejs.org)

- [Yarn](https://yarnpkg.com)

- A terminal

- A database of some sort

> Checkout [the Origami CLI](https://github.com/origami-cms/cli) for easy project setup and more.

Once you've got that setup, create a `.origami` file. This is used for Origami's configuration, and tells the platform things like what theme to use, what database credentials to use, etc. This can be automatically generated for you with `origami new` using the CLI.

Example `.origami` file:

```json

{

    "app": {

        "name": "Origami Site"

    },

    "store": {

        "type": "mongodb",

        "host": "localhost",

        "port": "27017",

        "database": "origami-site",

        "username": "origami",

        "password": "supersecret"

    },

    "theme": {

        "name": "snow"

    },

    "server": {

        "port": 9999,

        "secret": "6177fca40ba40bb859e277dc76dd67cf"

    }

}

```

After you have your `.origami` file and the cms, store and theme Node packages installed (automatically handled via CLI), you're good to go!

Simply run `origami` in the directory to start the server.