From e785c0836eb734db2751487dc8013ba720e828b0 Mon Sep 17 00:00:00 2001 From: Anna Viklund Date: Thu, 25 Apr 2024 10:21:56 +0200 Subject: [PATCH] Update README --- ui/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/ui/README.md b/ui/README.md index cb68c37bb..9a7c68792 100644 --- a/ui/README.md +++ b/ui/README.md @@ -1,12 +1,14 @@ -# AMI Platform +# AMI Data Companion UI -Web interface to explore data from automated insect monitoring stations. We use React and TypeScript for the implementation. The project was setup using [Create React App](https://github.com/facebook/create-react-app). +Web interface to explore data from automated insect monitoring stations. We use React and TypeScript for the implementation. The project was setup using [Vite](https://vitejs.dev/). ## System requirements - Node - Yarn +The `.nvmrc` file in project root describes what Node version to use to make sure we all use the same. To switch between Node versions, a version manager, such as [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm), is suggested. + ## Getting started ```bash @@ -50,6 +52,10 @@ To run tests: yarn test ``` +## Deployment + +We use [Netlify](https://www.netlify.com/) for deployment. Changes pushed to main branch are automatically deployed to https://app.preview.insectai.org/. When a pull request is opened, a preview version of the changes will be deployed. The URL to the preview deploy will be visible as a PR comment. + ## Storybook We use Storybook to document our design system in code. You can read more about Storybook [here](https://storybook.js.org/).