Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 2.94 KB

getting-started.md

File metadata and controls

52 lines (43 loc) · 2.94 KB

Getting Started

Welcome to the getting started page! Here is all you need to know to get this repo up and running on your local machine, as well as good collaborative coding practices

Contents

Setup for all Developers

  1. Clone this repository git clone <repo-url>
  2. Run npm i at the root of the repository
  3. Setup AWS Amplify
    1. Install the AWS CLI
    2. Run amplify pull --appId <app-id> --envName staging
      • get app-id from the top right in Amplify Studio
  4. Install IDE Extensions
  5. Enable format on save in your IDE
    1. Click the settings button in the bottom left
      VSCode Settings 1
    2. Search "formatter" and set your default formatter to Prettier
    3. Search "format on save" and click the checkbox
  6. Create an .env file in the root directory and ask a TL for any secrets
  7. Enable the pre-commit hook by running npx mrm@2 lint-staged at the root of your repository
  8. Familiarize yourself with Helpful Commands, the Project Structure, the steps for contributing, and the repository features.

Helpful commands

  • npm start: Boot up your frontend
  • npm run lint-check: make sure Prettier and ESLint pass
  • npm run lint-fix: make sure Prettier and ESLint pass and try to automatically fix all issues (some ESLint issues must be resolved manually)
  • git stash: Temporarily remove all local changes to a branch and save them. Good when you need to hop to another branch without committing your current code.
  • git stash apply: Reapply most recent git stash.
  • git merge origin/main: Pull all changes from the main branch to yours, good for resolving merge conflicts.

Project Structure