Git Product home page Git Product logo

flintcms's Introduction

FlintCMS is no longer under active development.

You can still use it as-is, but there won't be any feature or security changes. Have a nice day! โ˜€๏ธ


FlintCMS ยท npm version Build Status PRs Welcome Codecov

Flint is a CMS built to be easy to use and super flexible. Your content needs to fit into more layouts and environments than anyone but you can plan for, so Flint enables you to make the templates you need and fill it with your content.

It's a CMS that is built for those who want to fully design the front-end of their website without wanting to deal with static site generators or older content management systems (that are slow and use outdated technology).

Why?

Every content management system falls into one of two categories: can be customized a ton but is very cumbersome to work with, or can be customized too little but is very straightforward. Only a few seem to find that perfect balance; CraftCMS, which Flint is ultimately inspired by, is a great example. However, there are very few systems that take advantage of the performance and ecosystem of Node.js. Flint is really fast and is written using modern web standards so that newer developers can jump in, plus it's open source so more and more people can help make it better.

Getting Started

npm install flintcms --save

Then the entry point to your app:

const Flint = require('flintcms');

const siteConfig = {
  siteName: 'My Awesome Flint Site',
};

const flintServer = new Flint(siteConfig);

flintServer.startServer();

That's the basics! There's more to it than that, you can take a look at the docs to learn more.

Requirements

FlintCMS employs new Node.js standards and functionality, so ^8.0.0 is the supported version.

You'll need a MongoDB database of some kind, and you'll likely want a way to send emails through your site; you can read more about all of this on the FlintCMS docs.

Building with Flint?

If you're using FlintCMS in a project, thats awesome and I want to know! Feel free to open up an issue to let me know, and I'd be happy to list your project in this README.

Contributing

Thanks for your intesting in contributing to FlintCMS ๐Ÿ’– There are some things you need to know about how to contribute well, you can read about it in the CONTRIBUTING file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.