Updated README and made it easier to change the endpoints you are usi…

…ng for the visualization.

README.md

@@ -1,75 +1,22 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Morpheus
 
-## Available Scripts
+Morpheus is a visualization tool with the focus on visualization the the form and function of a test suite.
 
-In the project directory, you can run:
+## Running the visualization
 
-### `yarn start`
+Before the visualization can be run, we need to setup the [backend](https://github.com/kajdreef/spidertools). 
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+- `yarn install`: download all the dependencies to run the visualization.
+- `yarn start`: Runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+- `yarn build`: Builds the app for production to the `build` folder.
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+## Environment Variables:
 
-### `yarn test`
+| Variable Name              | Goal           | Example        |
+|----------------------------|----------------|----------------|
+| REACT_APP_API_ENDPOINT     | Configure the endpoint during compile time. | http://api.kajdreef.com |
 
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
 
-### `yarn build`
+For example, to change the endpoint for the visualization when running in development mode, run the following command:
 
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `yarn build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
-
-
-## RESOURCES:
-- https://medium.com/@Elijah_Meeks/interactive-applications-with-react-d3-f76f7b3ebc71
-- http://bl.ocks.org/Lichtphyz/88ba061011589c805eb016d0f9d61a79
-- https://www.d3indepth.com/enterexit/
-- http://bl.ocks.org/Lichtphyz/88ba061011589c805eb016d0f9d61a79
+`$ REACT_APP_API_ENDPOINT=http://api.kajdreef.com yarn start`

package.json

@@ -19,10 +19,10 @@
     "react-scripts": "3.4.1"
   },
   "scripts": {
-    "start": "REACT_APP_STAGE=dev react-scripts start",
+    "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "release": "REACT_APP_STAGE=prod react-scripts build",
+    "release": "REACT_APP_API_ENDPOINT=api.kajdreef.com react-scripts build",
     "eject": "react-scripts eject"
   },
   "eslintConfig": {