README.md

Focus on Nature

Camp registration platform for Focus on Nature!

Stack Choices

Backend Language: TypeScript (Express.js on Node.js)
Backend API: REST
Database: MongoDB
User Auth: Opt-in
File Storage: Opt-in

The provided frontend is a React application written in TypeScript.

Table of Contents

• 👨‍💻 Getting Started
  • ✔️ Prerequisites
  • ⚙️ Set up
• 🧰 Useful Commands
  • ℹ️ Get Names & Statuses of Running Containers
  • ✨ Linting & Formatting
  • 🧪 Running Tests
• 🌳 Version Control Guide
  • 🌿 Branching
  • 🔒 Commits

Getting Started

Prerequisites

• Install Docker Desktop (MacOS | Windows (Home) | Windows (Pro, Enterprise, Education) | Linux) and ensure that it is running
• Set up Vault client for secret management, see instructions here

Set up

1. Clone this repository and cd into the project folder

git clone https://github.com/uwblueprint/focus-on-nature.git
cd focus-on-nature

2. Pull secrets from Vault

vault kv get -format=json kv/focus-on-nature | python update_secret_files.py

3. Run the application

docker-compose up --build

The backend runs at http://localhost:5000 and the frontend runs at http://localhost:3000.

Useful Commands

Get Names & Statuses of Running Containers

docker ps

Linting & Formatting

# linting & formatting warnings only
docker exec -it scv2_ts_backend /bin/bash -c "yarn lint"

# linting with fix & formatting
docker exec -it scv2_ts_backend /bin/bash -c "yarn fix"

Running Tests

docker exec -it scv2_ts_backend /bin/bash -c "yarn test"

Deployments

Staging

Backend (Heroku): https://focus-on-nature.herokuapp.com/
Frontend (Firebase): https://focus-on-nature.web.app/
Whenever a PR is merged our github actions will push the updated dev branch to the staging environments.

Version Control Guide

Branching

• Branch off of dev for all feature work and bug fixes, creating a "feature branch". Prefix the feature branch name with your name. The branch name should be in kebab case and it should be short and descriptive. E.g. sherry/readme-update
• To integrate changes on dev into your feature branch, use rebase instead of merge

# currently working on feature branch, there are new commits on dev
git pull origin dev --rebase

# if there are conflicts, resolve them and then:
git add .
git rebase --continue

# force push to remote feature branch
git push -f

Commits

• Commits should be atomic (guideline: the commit is self-contained; a reviewer could make sense of it even if they viewed the commit diff in isolation)
• Trivial commits (e.g. fixing a typo in the previous commit, formatting changes) should be squashed or fixup'd into the last non-trivial commit

# last commit contained a typo, fixed now
git add .
git commit -m "Fix typo"

# fixup into previous commit through interactive rebase
# x in HEAD~x refers to the last x commits you want to view
git rebase -i HEAD~2
# text editor opens, follow instructions in there to fixup

# force push to remote feature branch
git push -f

• Commit messages and PR names are descriptive and written in imperative tense¹. The first word should be capitalized. E.g. "Create user REST endpoints", not "Created user REST endpoints"
• PRs can contain multiple commits, they do not need to be squashed together before merging as long as each commit is atomic. Our repo is configured to only allow squash commits to main so the entire PR will appear as 1 commit on main, but the individual commits are preserved when viewing the PR.

---

1: From Git's own guidelines