https://github.com/bcbi/solrplantwebapp
Web App to interface with SolrPlant API
https://github.com/bcbi/solrplantwebapp
Last synced: over 1 year ago
JSON representation
Web App to interface with SolrPlant API
- Host: GitHub
- URL: https://github.com/bcbi/solrplantwebapp
- Owner: bcbi
- License: mit
- Created: 2018-04-17T20:57:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T10:03:06.000Z (over 3 years ago)
- Last Synced: 2025-02-02T01:27:35.332Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://bcbi.brown.edu
- Size: 5.68 MB
- Stars: 0
- Watchers: 6
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SolrPlantWebApp
Web App to interface with SolrPlant AP
This is the front end of [http://bcbi.brown.edu/solrplant](http://bcbi.brown.edu/solrplant).
The backend is a Julia Server with [GitHub Repository](https://github.com/bcbi/SolrPlantAPI)
This front end is a Single-Page-React Application with the following characteristics:
* Based on create-react-app
* Redux pattern for handling application-state
* ReactRouter for handling routes
* ReactBootstrap for UI
* Redux-Saga for asynchronous tasks
## Live site
This site lives at [http://bcbi.brown.edu/solrplant](http://bcbi.brown.edu/solrplant)
## Contents
1. [Getting this App up and running in developer mode and localhost](#running-in-developer-mode)
2. [Deploy with Docker and NGINX](#deploy-with-docker-and-nginx)
## Running in developer mode
1. First of all [Install or update NVM and Node](https://github.com/bcbi/SolrPlantWebApp/blob/master/INSTALL_NODE.md#install-or-update-nvm-and-node) (if you haven't done so)
2. Clone this repository:
```
git clone https://github.com/bcbi/SolrPlantWebApp.git SolrPlantWebApp
```
3. Changes for developemnt
Currently the client submits http requests to a bcbi.brown.edu. When testing locally you may want to run your server locally as well.
4. Install npm
```
npm install
```
5. Start client
```
cd YOUR_PATH/SolrPlantWebApp
cd client
npm start
```
The last lines of the output should be
```
Starting the development server...
Compiled successfully!
The app is running at:
http://localhost:3000/
Note that the development build is not optimized.
To create a production build, use npm run build.
```
You can now point your browser to http://localhost:3000/!
## Deploy with Docker and NGINX
1. Build image and make it available
This repository includes a shell script to build, publish and test your docker image.
To build the Docker image:
```
cd SolrPlantWebApp
./docker_utils.sh "build"
```
The image default name is bcbi/solrplant_web_app and can be pushed into BCBI's docker hub account (if permissions) using
```
./docker_utils.sh "push"
```
2. Pull image into server
Assuming your image is now available at DockerHub, you can now pull your image
```
docker pull bcbi/solrplant_web_app
```
3. Run image in container
```
docker create -d -p 3000:3000 --restart=always --name solrplant_web_app bcbi/solrplant_web_app
docker start
```
-d runs in deattached mode.
4. Test in localhost
At this point the app is available at http://localhost:3000
5. Configure NGINX
If running in a subdirectory myserver.com/riair, you need to add a new location to your /etc/nginx/nginx.conf
```
location /solrplant/ {
proxy_pass http://127.0.0.1:3000/;
}
}
}
```
* Note The '/' at the end of the paths is important a it tells nginx to strip it from the calls to out server.
Final considerations:
* Create-react-app scripts need to be aware that you're not in the root directory. To do so, make sure
that in /client/packege.json, you specify it in the homepage field (already done but good to be aware of)
```
"homepage": "http://localhost:3000/solrplant/",
```
This will have the effect that when npm run build is executed the static index.html will correctly set the links to static files, e.g.
```
```
## Fixing security vulnerabilities
From time to time, GitHub will notify you that one or more security vulnerabilities have been found in the `SolrPlantWebApp` repository. When this happens, the easiest approach is to use Dependabot to open a pull request that fixes the vulnerability. To do this, first go to [https://dependabot.com](https://dependabot.com) and click on the `Log In` button in the top right hand corner to log in with GitHub. Then, go to the BCBI dashboard at [https://app.dependabot.com/accounts/bcbi](https://app.dependabot.com/accounts/bcbi). Next to `SolrPlantWebApp`, click on the `Bump now` button. This will trigger Dependabot to scan the `SolrPlantWebApp` repository for vulnerabilities and open pull requests to fix them. After Dependabot has opened one or more pull requests, merge them. Depending on how many vulnerabilities were found, you may need to return to [https://app.dependabot.com/accounts/bcbi](https://app.dependabot.com/accounts/bcbi) and click the `Bump now` button next to `SolrPlantWebApp` several more times in order to close all of the vulnerabilities.
Sometimes, Dependabot will not be able to fix a vulnerability because of conflicts inside the `client/package-lock.json` file. In this case, you will need to manually update all dependencies on your local machine. Here are step-by-step instructions for doing this:
1. `git clone git@github.com:bcbi/SolrPlantWebApp.git`
2. `cd SolrPlantWebApp`
3. `git branch yourinitials/update-dependencies`
4. `git checkout yourinitials/update-dependencies`
5. `cd client`
6. `rm -f package-lock.json`
7. `npm install`
8. `npm update`
9. `git add -A`
10. `git commit -m 'Update dependencies'`
11. `git push origin yourinitials/update-dependencies`
12. `cd ../..`
13. `rm -rf SolrPlantWebApp`
14. Now go to `https://github.com/bcbi/SolrPlantWebApp/pull/new/yourinitials/update-dependencies` and create a new pull request.
15. Wait for all of the checks to pass on your pull request.
16. Merge your pull request.
17. Delete the `yourinitials/update-dependencies` branch.