Skip to content

Commit

Permalink
Decribe dev setup
Browse files Browse the repository at this point in the history
  • Loading branch information
wbbaker committed Aug 22, 2024
1 parent bb41271 commit d8e07f4
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
# Purdue

This is a fork by of [TaxonPages(https://github.com/speciesFileGroup/taxonpages)
to search the [Purdue Entomological Research Collection](https://ag.purdue.edu/department/entm/perc/) (PERC).

## Developing

There are two repos, which each have their own set of Github Pages for deployment automation:
* Production — [taxonpages](https://github.com/PurdueEntomologicalResearchCollection/taxonpages)[published here](https://purdueentomologicalresearchcollection.github.io/taxonpages/)
* Development — [taxonpages-dev](https://github.com/PurdueEntomologicalResearchCollection/taxonpages-dev)[published here](https://purdueentomologicalresearchcollection.github.io/taxonpages-dev/)]

Why two repos? Because each [can only have one set of Github Pages](https://github.com/orgs/community/discussions/21582)
— and we want a way to deploy a development branch for QA.

Our standard practice is to work on two branches
* `main` — connected to the `prod` repo's `main` branch, and deployed to the PERC search page.
* `dev` — connected to the `dev` repo's `main` branch (and the `prod` repo's `dev` branch). Deployed to the PERC test search page.

Initial setup:

1. Clone the production repo
1. `git clone git@github.com:PurdueEntomologicalResearchCollection/taxonpages.git`
2. `cd taxonpages`
2. Fetch from the `dev` repo into a local `dev` branch.
1. `git remote add dev git@github.com:PurdueEntomologicalResearchCollection/taxonpages-dev.git`
2. `git pull remote main:dev`

Making changes:
1. Push changes to `dev` (they will deploy automatically)
1. TODO add details
2. Merge up to `prod` (they will deploy automatically)
1. TODO add details

# TaxonPages

TaxonPages is a tool to serve taxon pages. At present it draws data from TaxonWorks' API, however we seek to keep the TaxonPages platform agnostic therefor facilitating the modular addition of functionality that may reference data from any biodiversity data-serving API.
Expand Down

0 comments on commit d8e07f4

Please sign in to comment.