DreamScholars

DreamScholars aims to provide scholarship information for undocumented students

This project was bootstrapped with Create React App.

Development Prerequisites

The following are required:

• Git
• Node.js
• Java
• Yarn

The following are recommended but optional:

• VS Code - most of our team uses VS Code.
  • Extension - ESLint - shows lint issues in your editor.
  • Extension - Prettier - autoformats your files according to our config.

Alternatively, Cloud Shell can be used.

Development Setup

1. Clone the repo or open it in Cloud Shell:

git clone https://github.com/beyondhb1079/s4us.git

2. cd into the repo and install npm-merge-driver so that yarn.lock merge conflicts are autoresolved:

npx npm-merge-driver install \
  --driver-name yarn-merge-driver \
  --driver "npx npm-merge-driver merge %A %O %B %P -c yarn" \
  --files yarn.lock

3. Install project dependencies by running:

yarn install

Common development actions

Updating dependencies

yarn install

This is needed whenever the yarn.lock file has changed.

Previewing the app

yarn start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Debugging the app

Chome Dev Tools makes it really easy to debug/prototype HTML, CSS, and JavaScript. Additionally, the React Developer Tools extension lets you inspect React props, state, and hooks.

Debugging Firebase Auth and Firestore

After running yarn start you can manage local Firebase Auth and Firestore data via the Emulator Suite at http://localhost:4000/.

Running tests

yarn test

Launches the test runner in the interactive watch mode. You can add Jest CLI options such as --coverage and --verbose.

The tests also run when you run a git push command.
You can skip the tests by adding the --no-verify flag to the push command.

See this section about running tests for more information.

Updating translations

yarn i18next

Will run the i18next-parser and extract any missing translations introduced.

Learn More

To learn React, check out the React documentation.

To learn about other languages, tools, and libraries we use, see the Learning Resources wiki entry.