Skip to content

Commit

Permalink
more development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Beecher Baker committed Sep 5, 2024
1 parent fd12a5a commit 56060c0
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Each is built using to GitHub Actions, following [these instructions](https://gi

## Local Dev Setup

Option 1: Work on both the prod and dev sites from a single local repo.

```bash
# 1. Clone the production repo
git clone git@github.com:PurdueEntomologicalResearchCollection/taxonpages.git
Expand All @@ -34,6 +36,24 @@ npm run dev
# TODO: Explain how to clean up after that funky branch setup
```

Option 2: Work only in one of the repos (simpler, but you can't commit changes to the other repo):

```bash:
# 1. Clone the repo you want to work on -- in this example, it's dev
git clone git@github.com:PurdueEntomologicalResearchCollection/taxonpages-dev.git
cd taxonpages-dev
# 2. Do TaxonPages' funky branch setup
git checkout main
git checkout setup .
# 2. Run locally
npm install
npm run dev
# 3. Make changes -- http://localhost:5173/taxonpages-dev/, edit code, and the app will hot-reload
# 4. Commit changes, being careful to not add foreign objects from the `setup` branch
git add .
# TODO finish this
git commit -m "Your message here"
```
---

# TaxonPages
Expand Down

0 comments on commit 56060c0

Please sign in to comment.