greenpress/greenpress

Start here: npm install & npm start

GreenPress

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

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 Issues

[admin] [ Feature ] Observe a list of available mail providers

[docs] Tools: Greenpress CLI

After the Docker migration is complete, document all CLI methods.

[blog-front] Chrome Audit fix: Add cache TTL for static files served from app

all images and static files are probably not there to be changed, so they should have much longer TTL.

[secrets] Add a Postgres DAO models

[mailing] [ Feature ] Support SMTP type email providers

[admin] [ Bug ] When creating a new post, category value isn't sent in request if not actively chosen, even though default value is presented

The fix should either send the default value that is presented or stop presenting a value at all (and alert on submit if nothing was chosen since its a required field). @davidmeirlevy which one do you think is better?

Change all master branches to be "main" instead of "master"

It should affect:

1. pipelines.
2. pipelines' hooks config.
3. greenpress-pm2 git sub-modules.
4. clone local dev repositories using the greenpress-cli.
5. .env.example file for scaled composition.

[Improvement] Add linter to all projects.

All projects should have an eslint, and editorconfig file.
Make sure the rules are enforced on CI and pre-publish.

[blog-front] GDPR Consent component

1. check if a cookie of the GDPR consent (cookie name: AgreedToCookies) exists.
2. if not - render the GDPR consent line at the bottom of the website (fixed position).
3. when the user agrees to the terms - should save a cookie for it (AgreedToCookies=${(new Date()).toJSON()})

[admin] [ Bug ] When submitting a new post, if there are errors, display them on the screen.

Currently, when creating a new post, if you submit and get a 400 response code from the server, with attached errors, they are not displayed to the user to see what he did wrong.

[content] Comments endpoints

apply commenting endpoints:

1. get all comments by post id
2. get all comments by path (category & post path).
3. for starters, all no inner-comments available.
4. regular users can get or create new comments.
5. editors and admins can also edit / delete.
6. verify encoding and HTML tags!

[blog-front] Signin + Signup components

Use the API to signin & signup to the blog.

can use the mechanism to login the admin panel (the API is the same, but admin panel requires different role).

Separate codefresh pipelines between main branch hooks and PRs hooks

As you can see, I already did it in the admin-panel repository, but it should be for all services:
should have 2 different pipelines - one that runs only on the main branch (currently master for most of them), and the second for PRs only, and to exclude the main branch explicitly.

[blog-front] Chrome Audit fix: Links to cross-origin destinations are unsafe

Add rel="noopener" or rel="noreferrer" to any external links to improve performance and prevent security vulnerabilities.

[admin] [ Feature ] Add a modal for personal user editing

When clicking on the user's name in the header, a modal should open where one could edit their:

1. name (first/surname)
2. credentials (email/password)

Add Drafts service to application

upgrade cli-service-pm2 that export drafts-service configurations.
also, install package @greenpress/drafts to greenpress.

[admin] [Feature] open image-upload modal on WYSIWYGs image button

scenario:

1. add content via WYSIWYG.
2. click on the "image" button to add image

current behavior: open "browse files" and it doesn't do anything.

expected behavior:

1. open modal to upload or search assets in manages storages, using the image uploader.
2. after the image was selected / uploaded - the image will be entered to the WYSIWYG content.

The modal basic behavior:

1. select a storage
2. view assets in storage.
3. drag & drop component (ImageUploader).
4. on image selection / upload - emit the image to the parent component.

Note: This feature has 2 mechanisms to control:

1. the GpEditor that used CKEditor.
2. the ImageUploader and the StorageService to manage storage.

[mailing] [Feature] CRUD for email template routes

create, read, update, and delete email templates (model already exists).

[mailing] [Feature] Send email with parameters

for endpoint such as:
POST /api/mailing/send

the request body should have:

{
  providerId: string,
  emailTemplateId?: string,
  subject: string,
  content: string,
  templateParams?: any,
  from?: string (email),
  to: Array<string>,
  bcc: Array<string>,
}

parts of those values can be inherited from the email template (subject, content, from, and part of the template params).

[admin] [ Bug ] Sometimes a blank page is loaded instead of the admin panel

Loading fails due to invalid token that is saved in the cache. The token should be cleared beforehand.

[assets] [Feature] Verify authentication properties on create / update storage

for instance:
make sure ftp has: url, username, password.
s3 should have: token, url, region, etc..

[pm2-launcher] Add the mailing-service to the runner configuration

mailing-service is a new service that should be part of the greenpress platform.
should be called mailing

[admin] [Categories] When a new category is added, make sure it is displayed in the header

At the moment, when a new category is added, it is indeed saved to the database, but it is now shown in the header.

[admin] Plugins mechanism

Add capability to insert admin panel plugins easily.
every plugin should get ability to insert routes, and insert components to several editing screens.

for example: plugins that can be used from the "edit post" page, to help you add posts, etc..

[admin] [Menus] ability to add / remove / update

Create a better UX to add / remove / update menus.
make sure that the main menu is not removable.

The API is a simple CRUD and already exists:
GET /api/menus - get all
POST /api/menus - create
PUT /api/menus/:menuName - update
DELETE /api/menus/:menuName - remove a menu..

Update menu page already exists.. needs to have a better UX.

[admin] Provide test logins for Admin and other User Roles

Would like to contribute to issues for Hactoberfest but need a working login credentials that I can use for development.

[admin] [Posts list] Search Posts input to filter posts

ability to search posts by free text inside the posts page.

[Enhancement] support docker compose scripts

[admin] [ Enhancement ] Update code's version to VueJS3!

[api-kit] Convert to TS

[blog-front] API Endpoint to get list of themes

API endpoint, accessed only by admins roles, to get list of folders inside the "themes" folder.
will be used by admin panel in order to select and replace themes.

[admin] [ Bug ] Unsaved changes window unnecessarily pops up on a new post

The window pops up even though I haven't visited the new post panel before. Not consistent.

[admin] [Feature] Static image uploader

Every content editor wants a place to upload images and retrieve its public URL, that should be available from all pages.

Capabilities wanted:

• see list of files in storage
• upload files to storage and get their public URL.
• remove assets from this details panel
• move folders
• refresh list
• show asset name below/above image
• rename asset

You can use the ImageUploader component, and also manage the list of files in storage.

[blog-front] [ Feature ] Editors public profile page

The page should contain the following:

1. Name (first + surname)
2. Profile picture (if not provided, a default image will be displayed)
3. Author personal description (may be empty)

[admin] [ Feature ] Add a new mail provider, edit existing one, delete mail provider

[CLI] [Feature] live-replace environment on production machine

Consider a machine working with docker-compose.
The docker-compose YAMLs located at the compose directory in greenpress/greenpress repository.

currently, the YAML includes the following services: greenpress, mongo, redis.

configuration steps:

1. it should have an nginx / lightspeed that will be exposed on port 80. (call is the gateway)
2. mongo and redis should be exposed locally to 127.0.0.1, but not outside of the machine.
3. greenpress should get a random port.
4. the gateway should run and reverse-proxy to greenpress.

bootstrapping steps:

1. .env file should updateGREENPRESS_IMAGE variable from .env.production file.
2. docker run only to this image and pass all relevant variables with docker-compose. should run with a new random port on 127.0.0.1 only.
3. make sure it gets mongo and redis URIs, that should already running.
4. restart the gateway and pass the port of the new greenpress instance.
5. docker stop for the old greenpress instance.

the expected result:
the new version of greenpress should be up and running, using existing mongo and redis on the machine, and expose to port 80 using the gateway.

Mandatory:
all of this should be done with one single command.

[content] [Enhancement] Separate database operations from controllers to services

This issue should have several different PRs.

• menus
• tags
• posts
• categories
• configurations
• comments

Hint to start:

1. look at a controller file.
2. every function that doesn't expect request and response should not be defined there at all.
3. every usage for cache and models, should not be there either.
4. every actual building for mongo queries specifics should be out of there.

[CLI] [Feature] - autocomplete

There are a few npm packages that implement the autocomplete feature

yargs

yargs offers a simple autocompletion API:

var argv = require('yargs')
    .completion('completion', function(current, argv, done) {
        setTimeout(function() {
          done([
            'apple',
            'banana'
          ]);
        }, 500);
    })
    .argv;

UPDATE: yargs is picked

[admin] Manage Comments

Should have capability to edit / remove comments of posts.

[api-kit] Add readme file to describe the API

[admin] [Feature] Manage assets / storage connections

1. show list of storage connections.
2. add storage connection.
3. update storage connection.
4. remove storage connection.
5. get list / upload / remove / replace / change names for assets inside a storage collection.

[New service] mailing-service

A new service is required.
Currently, a basic functionality to send emails exists on the authentication service, and it should be removed from there.

core & fundamentals:

1. use the api-kit to create a restful API.
2. should have endpoints for editors & admins, and endpoints for internal services requests.
3. call secrets-service to store mail access.

Requested operations:

1. manage mail providers + access tokens.
2. manage templates for emails.
3. send emails by template + payload (used for admins and for internal services calls).

[blog-front] Email Verification Page

The URL should be:
${uri}/verification/email/${token}

should add verification text and button to verify.
API already exists in authentication-service.

[assets] [Change request] Remove encrypted data when failed to save storage

When creating storage, it can happen that the credentials are stored successfully but the actual storage failed to be saved.
In that case, we should remove the encrypted values stored in the secrets-service.

1. fo to apps/assets
2. look for POST /api/storage endpoint (creating storage providers).
3. on the controller (createStorage) - when getting the credentials- check the connection before storing the credentials at the secret service.
4. do the same for the updateStorage function at the controller.

[secrets] Add a MySQL DAO models

[admin] [ Feature ] Add mail template

[auth] [Improvement] convert project to Typescript - phase 1

As for phase 1:

1. Create A TS config.
2. Replace all JS files to TS.
3. Make sure everything still runs as expected using typescript.

[mailing] [ Feature ] Support cloud email providers (e.g., SendGrid)

[front-ssr] Add open-graph meta tags for pages

all those meta tags should be existing, primarily for posts:

described here: https://css-tricks.com/essential-meta-tags-social-media/

<meta property="og:title" content="European Travel Destinations">
<meta property="og:description" content="Offering tour packages for individuals or groups.">
<meta property="og:image" content="http://euro-travel-example.com/thumbnail.jpg">
<meta property="og:url" content="http://euro-travel-example.com/index.htm">

[assets] [Feature] FTP storage management

• get assets list by path
• remove file / directory
• upload file
• rename file
• for get assets list - return only {name, identifier, size, type: 'file' | 'directory'}