Skip to content

Latest commit

 

History

History
143 lines (86 loc) · 4.9 KB

README.md

File metadata and controls

143 lines (86 loc) · 4.9 KB
Raw

STEM+C

Cloud-based programming interface


Scaffolds

/

client/

Client is the frontend of the application. It is powered by React and Blockly.

cms/

Cms is the REST API and admin portal that powers the backend. It is powered by Node and Strapi.

compile/

Compile is an arduino compiler service. It is an unofficial fork of Chromeduino.


Environments

The project is divided into three conceptual environments.

Development

This project's dependencies are managed through yarn. This effectively replaces npm and should be used in place of npm everywhere except sc-compile-dev. The following are the available scripts we can use with the client and server:

Structure

The development environment is composed of four servers. The first one is run with the Create React App dev server. The later three are containerized with docker and run with docker compose.

  • stem-c-client-dev - localhost:3000
  • stem-c-cms-dev - localhost:1337
  • stem-c-compile-dev - localhost:8080
  • stem-c-db-dev - localhost:5432

Running

stem-c-client-dev

  1. Install Node and Yarn

  2. Run the following commands sequentially

    cd client
yarn install
yarn start

stem-c-cms-dev, stem-c-compile-dev, and stem-c-db-dev

  1. Install docker

    If you do not meet these requirements docker desktop will not initialize popery. There are some unofficial modifications, however, we recommend installing the docker toolbox

  2. Run docker-compose up

    Grant cms permission if it prompts you

Staging

Structure

The staging environment is deployed on Heroku. It is composed of one app running a Heroku Postgres instance and a web container.

  • stem-c-staging - stem-c-staging.herokuapp.com
    • The web container attached to this Heroku app runs cms and serves static client build files
    • The Heroku Postgres instance is attached as an add-on

Running

stem-c-staging is automatically built from the latest commits to release. Heroku runs the container orchestration from there.

Production

Structure

The production environment is deployed on Heroku. It is composed of two apps. One is running a Heroku Postgres instance and a web container and the other is running just a web container.

  • stem-c - stem-c.herokuapp.com
    • The web container attached to this Heroku app runs cms and serves static client build files
    • The Heroku Postgres instance is attached as an add-on
  • stem-c-compile - stem-c-compile.herokuapp.com
    • The web container attached to this Heroku app runs compile

Running

stem-c is automatically built from the latest commits to master. Heroku runs the container orchestration from there.

stem-c-compile is manually deployed through the Container Registry and Heroku CLI.

  1. Install Heroku CLI
  2. Run the following commands sequentially
heroku login
heroku git:remote -a stem-c-compile
heroku container:login
heroku container:push web
heroku container:release web

Contributing

Git Flow

We will follow this git flow for the most part — instead of individual release branches, we will have one to streamline staging deployment

Git Flow

Branches

Protected

Locked for direct commits — all commits must be made from a non-protected branch and submitted via a pull request with one approving review

  • master - Production application

Non-protected

Commits can be made directly to the branch

  • release - Staging application
  • develop - Working version of the application
  • feature/<scaffold>-<feature-name> - Based off of develop
    • ex. feature/cms-strapi
  • hotfix/<scaffold>-<fix-name> - Based off of master
    • ex. hotfix/client-cors

Pull Requests

Before submitting a pull request, merge the target branch into the working branch to resolve any merge conflicts. Include a description of the changes made.

  • PRs to master should squash and merge
  • PRs to all other branches should create a merge commit