Skip to content

README.md

Latest commit

 

History

History
65 lines (41 loc) · 1.13 KB

README.md

File metadata and controls

65 lines (41 loc) · 1.13 KB

Foster Finder

Foster Finder is an innovative app connecting shelters and fosterers, facilitating the seamless listing and notification of critical care foster kittens in need.

Requirements

  • Node.js
  • npm
  • Docker

Getting Started

  1. Run the following command to install dependencies:
npm install
  1. Run the following command to start the database:
npm run db:start
  1. Run the following command to run database migrations and seed data:
npm run db:reset
  1. Run the development server:
npm run dev

Open http://localhost:3000 with your browser to see the result.

Tests

To run tests, run the following command:

npm run test

Tests also run automatically pre-commit.

UI Tests

We use snapshot testing for our UI components. These tests will fail if the UI changes. To update snapshots, double check that the UI changes are intended and then run the following command:

npm run test:update

Developer Tools

See docs/devtools.md

Architectural Decision Records

See docs/adr/README.md