Skip to content

marmelab/greenframe-demo-ra

Repository files navigation

greenframe-demo-ra

A demo project to demonstrate greenframe integration with github.

The project is composed of a front end (React admin) and a backend (Postgrest) connected to a db in Postgres. Greenframe demo architecture

Getting started

Install dependencies

Run make install to install the dependencies. It will also init and seed the db with data-generator-retail.

Start the project

Run make start to start the server. It will start :

  • The db (postgres) on port 5432
  • The api (using postgrest) on port 8000
  • The frontend (React admin) on port 3000

Go to http://localhost:3000 to see the app.

Stop the project

Run make stop to stop the server. It will remove the containers, so the data will be lost.

Making a PR

Testing Greenframe integration with github.

Analyzing the Project with Greenframe

The repository contains a .greenframe.yml and a scenario.js file, so all you need to do to run an analysis is to run:

$ greenframe analyze