Giter VIP home page Giter VIP logo

CircleCI Running tests

GreenPress

Open-source blogs and content websites platform, made for the 21st century. Greenpress

Dependencies

Direct usage

  • Node.js
  • NPM
  • Docker / MongoDB
  • (Optional: Redis)

Dockerized usage

  • Docker
  • Docker Compose

Getting started

Install

$ npm install
$ npm run build

Run production

$ npm start

Run development

# In case you have separated MongoDB instance on your local machine:
$ npm run dev

# In case you don't (will run MongoDB using Docker):
$ npm run dev --x=all

Dockerized Usage

Pre-running

Before running a docker-compose environment, you'll need an .env file and the compose library.

You can just copy the .env.example and call it .env (manually), but you can also do it on command line:

$ cd compose

# for linux or mac:
$ cp .env.example .env

# for all operation systems (including windows):
$ npm run create-env

Running Greenpress via Docker-Compose is a very simple task. You might need to pre-install Docker and Docker Compose, and then run these commands:

$ cd compose
$ docker-compose up

Scaling dockerized application

When using dockerized solution, you can choose to run each service separately, and scale each service according to your needs. To run a composition that is more suitable to those cases, use the "scaled" yaml:

$ cd compose
$ docker-compose -f docker-compose.scaled.yml up

If you're using a small machine, such as shared hosting packages, or low cpu or memory cloud services, you should probably use the basic environment, such as the regular compose file, or directly using Node.js.

Set custom configurations

There are 2 ways to extend the default Greenpress configurations. Basic way is by environment variables, and the second part is to add a greenpress.config.js file to your project's root folder.

The greenpress.config.js can either export the configuration object, or export a function that will get the base configuration object, and expected to return a new configuration object. Note that the base configuration object passed to the function will include data that calculated by environment variables before.

Greenpress's Projects

front-next icon front-next

Frontend service with SSR using Next.js for greenpress platform.

gp-editor icon gp-editor

Flavoured WYSIWYG content editor for Greenpress

greenpress-installer icon greenpress-installer

An executable web application to run locally in order to create and manage Greenpress applications

microf icon microf

Almost-zero-configuration plugins to create micro-frontends infrastructure.

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.