Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.5 KB

README.md

File metadata and controls

65 lines (37 loc) · 2.5 KB

STEM+C

Scaffolds

Project

Client

The frontend is built on top of React and Blockly. It will be deployed in the cloud and distributed with a CDN.

Server

The backend is built on top of a headless CMS. It will be deployed in the cloud and utilize various services.

Environments

Development

This project's dependencies are managed through yarn (this must be installed) using yarn workspaces. This allows both client and server folder dependencies to only depend on one package-lock file, reducing possible dependency version issues. From the project root running the command yarn will install dependencies for both the client and server. The following are the available scripts we can use with the client and server:

yarn workspace server dev

Runs both the client app and the server app in development mode.
Open http://localhost:3000 to view the client in the browser.

yarn workspace client start

Runs just the client app in development mode.
Open http://localhost:3000 to view the client in the browser.

yarn workspace server start

Runs just the server in development mode.

yarn workspace server build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

Deployment

Coming soon...

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.