Onboarding The Repo of Sincere Exercise

Note: There are two repos in this organization

cse110-fa22-group19 - Repo containing our meetings, ADRs, team logs, etc.
sincere-exercise - Repo containing the app itself.

Setting up the project to run

npm i to install all dev dependencies
Run a live server from the root of this repository

Project Workflow

Checkout to a new branch (naming practice in ADRs)
Make changes
git commit ... changes
1. This will trigger E2E tests, linting, and code styling.
2. If E2E test fail on the main branch, consider:
- Confirming the URL in the test files with your root link on live server
- Installing packages
- Running npm test to run all tests, including unit tests
git push changes
On GitHub, make PR if completed work, requesting reviewers and linking the issue
Actions run, running lint & unit tests, and generating documentation after tests pass
Code is merged

Repo Structure

App

The directory that stores all app content

core: contains CRUD functions with localStorage
main: contains all components - View & Controllers
shared: contains components shared throughout entire app

Assets

The directory that stores all static media content

Docs

The directory that stores documentation of our code

Link to documentation

Test files

__tests__ - the directory that contains unit tests and e2e tests
setup - the directory that contains the mock localStorage for unit tests

Config files & directories

.github - contains all Github action files
.husky - contains a pre-commit hook script
.eslintrc.js - the ESLint config file
.prettierrc.json - the Prettier config file
babel.config.js - the babel config file
jest-puppeteer.confic.cjs - the Jest Puppeteer config file
jsdoc.json - the JSDoc config file