Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 1.88 KB

README.md

File metadata and controls

66 lines (40 loc) · 1.88 KB
Raw

STEM+C


Scaffolds

/

  • client/

    Client is the frontend of the applcation. 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 compilier service. It is an unofficial fork of Chromeduino.


Setup

Development

This project's dependencies are managed through yarn The following are the available scripts we can use with the client and server:

The development environment is comprised of three services managed by docker compose.

  • sc-client-dev => localhost:3000
  • sc-cms-dev => localhost:1337
  • sc-compile-dev => localhost:8080
  • sc-db-dev => localhost:3306

To get started, simply

  1. Install docker
  2. Add strapi.sql to cms/
  3. Run docker-compose up

Deployment

TODO


Contributing

Git Flow

Git Flow

Ideally, we want our flow to resemble this. Master and develop are locked for direct commits. All commits must be made to a non-protected branch and submitted via a pull request with one approving review.

Branches

  • master - Deployed version of the application
  • develop - Working version of the application
  • feature/<scaffold>-<feature-name> - Based off of develop
    • ex. feature/server-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.