Merge pull request #382 from annavik/main

Update README
RolnickLab · Apr 25, 2024 · 277add8 · 277add8
2 parents 96640d8 + e785c08
commit 277add8
Showing 1 changed file with 8 additions and 2 deletions.
diff --git 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/).