An app for managing the people.
This section describes some of the general things you should know about this repo.
This repo is powered by yarn workspaces. By leveraging this technology we are able to cleanly layout the parts of the application. While also maintaining the ability to share code between them.
The ability to share models greatly helps in the typescript space. Without this we would have to maintain duplicate copies of the primary models we work with (ie. User).
The backend is an express typescript app. It utilizes knex as its DB interaction Layer. In development/locally it uses a sqlite3 DB. In production it will use a postgresql DB.
-
Setup your env var file by copy pasting the contents of
packages/backend/env/.env.sampleinto a newpackages/backend/env/.env.localand filling it out with appropriate values. -
Running the application:
# Install dependencies
yarn
# Start DB (in a different terminal tab)
docker-compose up
# Do migrations
yarn db-migrate
# Seed DB with test data (optional, but convenient)
yarn db-seed
# Run locally (this starts up the frontend react server and the backend express server with live reloads)
yarn dev
The app is primarily powered by MaterialUI. Which is great for everyone that doesnt love doing a bunch of CSS.
I picked this color pallette to give us some additional colors to mess with https://coolors.co/palette/f94144-f3722c-f8961e-f9844a-f9c74f-90be6d-43aa8b-4d908e-577590-277da1.