GithubHelp home page GithubHelp logo

chalkclassroom / coachingapp Goto Github PK

View Code? Open in Web Editor NEW
14.0 4.0 7.0 155.41 MB

Data Acquisition and Coaching Application for Teachers and their Coaches

Home Page: https://chalkcoaching.com

HTML 0.08% JavaScript 9.52% CSS 0.02% TypeScript 90.38%
react

coachingapp's Introduction

CodeFactor Github Actions Status DeepScan grade Codacy Badge

New Branch Workflow:

1. Create new branch for each new feature you work on

a. Checkout develop branch with "git checkout develop"
b. Create new branch from master with "git checkout -b 'feature/<new-branch-name>'" or 'bug/<new-branch-name>'
c. Add changes
d. Commit `git commit -m "message"`
e. Push `git push`

2. Creating Pull Requests

To learn, check out the How to Create Pull Requests.

Available Scripts

First Run for Development?

RUN

1. npm install
2. npm run firebase:local
3. npm run localdev

npm run firebase:local will configure and start the Firebase emulator suite. On your first run, you will need to open the emulator suite and add yourself as a user. Any data you modify will be saved locally for future use.

In the project directory, you can run:

npm run livedev

Dev server will run which will watch if any file changes and updates instantly.

npm run localdev

Will start the live development server preconfigured with the environment information needed to connect to the Firebase emulators.

npm run firebase:local

Configures the Firebase emulator suite for local development and starts the emulators.

npm run prod

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

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run lint

Launches the ESlinter to show errors.

npm run cypress

Launches the test runner in the interactive watch mode.

npm run test

Launches the test runner locally in CLI.

npm run recordtest

Launches the test runner in the Cypress Cloud Dashboar

npm run devdeploy Deploy to Dev Environment

  1. Make sure you are logged in via firebase-tools cli into CQREF Account
  2. run devdeploy in the command prompt.

npm run stagingdeploy Deploy to Staging Environment

  1. Make sure you are logged in via firebase-tools cli into CQREF Account
  2. run stagingdeploy in the command prompt.

npm run deploy Deploy to Production

  1. Make sure you are logged in via firebase-tools cli into CQREF Account
  2. run deploy in the command prompt.

gcloud functions deploy helloGET --runtime nodejs8 --trigger-http Deploy Cloud Function

  1. Instead of helloGET substitute with function Folder name
  2. CI/CD Is not done for Cloud Functions so deploy and submit pull request.

Learn More

JSDocumentation is Available at Chalk Docs. You can learn more about webpack at Webpack. To learn React, check out the React documentation. To learn Cypress, check out the Cypress documentation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.