mount-vernon-trail

Intro

Hello and welcome to the Friends of the Mount Vernon Trail project! We'll be working, communicating, and logging bugs here, as well as in our other communication channels. Check back here for more on project and environment setup soon!

Repo layout

• frontend/ — the Expo (React Native) app. Run with cd frontend && npm install && npm start.
• backend/ — Node + TypeScript service that will proxy Google Photos uploads into the MVT-owned album. Deployed on Render. Currently a scaffold; no server code yet.

Procedures

Cloning

Please clone with SSH. See here to set up a key for your device if it doesn't have one already. Check this out for step-by-step instructions on cloning a repo.

Making branches, commits, + PRs

Explore the PR documentation

Every task will be completed on its own branch. If there are multiple engineers on your task, you can all use the same branch. You can create the remote branch first or create locally and push it.

Branch naming convention: Please start new feature task branches with feature/ and bug fix task branches with bugfix/.

Aim for short, descriptive commit messages. A good way to think about it is to imagine your commit message finishes the sentence "This commit will...". Also, double-check that you're on your branch and not committing secrets or .env information. Then, push your changes to your branch!

Pull from main, merge it into your branch, and test your code again before PRing. This will hopefully mean that you'll be all set to merge once we approve it.

When you're done with the task and have tested your code, make a PR for us to review. Give it a descriptive title. A template should populate with guidelines on how to fill out the description. The more information you give us, the faster we'll be able to get your PR approved!

Requesting review: Our github usernames are bsthapar and asea-aranion.

An example

git checkout -b feature/login

# add/edit files

# the following can also be done in vscode source control
git add -A
git commit -m "create login page frontend"
git push -u origin feature/login
# for subsequent pushes, just 'git push' will work

# repeat until task is complete

git checkout main
git pull origin main
git checkout feature/login
git merge main
# resolve conflicts
# open github and make PR

Meet the engineers!

Name	James Zhou	Jai Patel
Aaryan Patel	Ryan Zhao	Name
Chloe Thompson	Srinidhi Gubba	Indira Shafii