Dream Renewables CMS

Contents

• About This Project
• Setup
  • Requirements
    • Installing project dependencies
• Usage
  • Running the Application
• Continuous Integration, Development and Deployment
  • CI/CD
• Further documentation
  • Related Repositories

About This Project

This is the Repo/Code for the Dream Renewables CMS. This application primarily utilises the following technologies:

• Strapi
• Heroku Deploy with Git

Setup

Requirements

This project requires the following pre-requisites:

1. NodeJs

Installing project dependencies

1. Clone the repo to your chosen directory
2. Install dependencies npm i
3. Create a .env file in the project root directory: e.g touch .env
   • Secrets can be sourced from Heroku or a project admin
4. Build the admin panel with: npm run build

Usage

Running the application

To run the application you must ensure you've followed the setup steps

• To run the app via Node:
  • Ensure you're in the root directory
  • spin up the application: npm run dev

Continuous Integration, Development and Deployment

CI/CD

This project uses Heroku Deploy with Git. In order to deploy merge a branch to main, once merged to main a hook in Heroku will catch and deploy the application.

Further documentation

In order to build new content you must run the application locally in develop mode. From here you can build out the content via the UI which will automatically create relevant types as well as necessary endpoints to fetch content. Once satisfied and the branch has been merged into main Heroku's attached PostgresDB will update and you will be able to write the new content in the production Strapi view ready for the frontend to pull.

Additional Strapi Information

• Resource center - Strapi resource center.
• Strapi documentation - Official Strapi documentation.
• Strapi tutorials - List of tutorials made by the core Strapi team and the community.
• Strapi blog - Official Strapi blog containing articles made by the Strapi team and the community.
• Changelog - Strapi product updates, new features and general improvements.
• Strapi GitHub repository - Strapi repo for further information
• Discord - Chat with the Strapi community including the core team.
• Forum - Place to discuss, ask questions and find answers, and get feedback or just talk with other Community members.
• Awesome Strapi - A curated list of awesome things related to Strapi.

Related Repositories

Name	Description
Dream Renewables Frontend	React code for this web application
Dream Renewables Infrastructure	The Terraform for this web applications required architecture