diff --git a/README.md b/README.md index 5a05673..0dc9e24 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ TaxonPages is a tool to serve taxon pages. Click on "Use this template" button to create your own repository from this -### Setup +### Setup - Github Pages 1. Switch to `config` branch in your TaxonPages repository. 2. We provide some settings by default to setup your public pages, but API parameters are required and must be configured to get the data from your TaxonWorks project. @@ -19,7 +19,39 @@ Click on "Use this template" button to create your own repository from this 3. Push the changes after update the configuration files inside `config` branch 4. GitHub actions will build TaxonPages with the current configuration in `config` branch and publish it to the `gh-pages` branch -## Customization +# Install + +Follow this steps to run TaxonPages in your local machine. + +1. Install [NodeJS](https://nodejs.org/en/download/) +2. Fork this repository and clone it, or clone this repository using [GIT](https://git-scm.com/): + +``` +git clone https://github.com/SpeciesFileGroup/taxonpages.git +``` +3. Go to `taxonpages` folder and switch to `main` branch +``` +cd taxonpages +git checkout main +``` +4. [Download](https://github.com/SpeciesFileGroup/taxonpages/archive/refs/heads/setup.zip) configuration branch and paste `config` and `pages` folders inside taxonpages folder. + +5. Setup `config/api.yml` with the API server configuration + +6. Install node dependencies +``` +npm install +``` + +## Start TaxonPages + +``` +npm run dev +``` + +TaxonPages will be running at http://localhost:5173/ + +# Customization ### Pages