From 08f5d16492f0fbe6387e594dfcbc59ff3f1c6705 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Luis=20Pereira?= Date: Wed, 2 Nov 2022 22:25:16 -0300 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e59f55e..aaeaf85 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,43 @@ TaxonPages software is in active development and changes are expected that will 3. Push the changes after update the configuration files inside `setup` branch 4. GitHub actions will build TaxonPages with the current configuration in `setup` 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. We recommend you to fork this repository to keep getting updates. Use [GIT](https://git-scm.com/) to clone the repo. + +``` +git clone https://github.com//.git +``` +But if you don't want to fork it, you can clone directly from this +``` +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