Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
uyxela committed Sep 20, 2020
1 parent c633c74 commit d82949b
Show file tree
Hide file tree
Showing 24 changed files with 61 additions and 2,829 deletions.
26 changes: 26 additions & 0 deletions .firebase/hosting.YnVpbGQ.cache
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
asset-manifest.json,1600610259650,dd27f9d05c611bffac57c5373d48e1f13268427f806e2c8333f15c873050757d
favicon.ico,1600610228960,12c77055696278694a8feb77a9421dd85f8af25a81d812822be112e4be628fcf
index.html,1600610259640,ffe0b4a8d0c1b6cb329ea7de4ee8bc26b778a342d65dada87e72d956ba19babc
logo192.png,1600610228960,76c449ccb9cd117c2f2338f091b18f7050f3210e249b2228f5c81b23f34377cd
manifest.json,1600610228960,0958a5e0c831126100c8c2d06a6bbaa665a3900f21aaff4130238a6f5a113aa1
logo512.png,1600610228960,7779210d56c1f3741e2e487799fe3092def4fa6ac450a60532b807c3a8971205
precache-manifest.087cede7e739bd9973a1857194e00454.js,1600610259650,18d3ffafcac5f0307aa9db9676a38dcd3c7b75cea6b8e07e838a19f81cbe513e
robots.txt,1600610228960,2544ca049f223a42bff01f72ad930a5edba75bbb7199d0f8430a02ff5aca16ec
service-worker.js,1600610259650,3efa61b6b1c86e9481165886766b09a1e121d5f1cd56e523bdc1f317d55c334c
static/css/main.97ba0920.chunk.css,1600610259640,b7ac7cb9ae6438a1845c456055a46553f5a345d3311579debaf11c4c33ab2aca
static/js/2.e2177470.chunk.js.LICENSE.txt,1600610259640,312b03527a4464abd4aefc477a6098190e53a4230e981386f2f55ed0e5731c19
static/css/main.97ba0920.chunk.css.map,1600610259640,49598a56da7d95654347835d57239e327309f6a8724dc4ea19929278fcb08c97
static/js/runtime-main.2b546755.js,1600610259640,1a32b3ae478864d16395ba8fb804885ddd877291ddc34cef54a19886522dc141
static/js/runtime-main.2b546755.js.map,1600610259650,af281585296357cc48db20525bcba81a70a07eb67aae11ee6cf4ec9af56d497d
static/media/environment.2979ba4c.svg,1600610259630,2a953704416ffc5eea1ac0b9e2f325455b3146a85dcedeefd0f84c9a37452a79
static/media/large2.7ecab68b.svg,1600610259640,15efb7f69be05cf853b32a0afc0c27a23595234056807d2ed1af78c11158cfa0
static/media/large3.9e63e847.svg,1600610259640,940a95333f8ee4268649c5fc4b0ccd94545177be08f68325598764d828c74396
static/media/large1.e369b29c.svg,1600610259640,890d3c4eb901ca032784d21f9ab836c2e70ece158a6db45447fdeea0d373734d
static/media/large6.9a6143d3.svg,1600610259640,377f68f7cae6b1a96865facd12db044c58919442dcd2e93ab0d9f57b009e500e
static/media/large4.7441baee.svg,1600610259640,17a5fc9f4d854b85efaff7b7d1c16468f6efaa79225d026c8c27f86758161e00
static/media/large5.79f50a14.svg,1600610259640,826f5c7550594b9a24a0da4be436064b435c6eb04f61407cd5bc64d445910ae8
static/media/logo.9cdc0432.svg,1600610259640,dac28a3894d837099dea6045208845eee0b61c60ee841c868563e7c6001567d6
static/js/main.d08b0b92.chunk.js.map,1600610259640,803ba431d5c86eaa9e2360ea48af7146f6f09fe19eb119d302c7eb07b336264c
static/js/2.e2177470.chunk.js,1600610259640,6d12f4a6a8e9929096347d1e3f499094df47542d377a3f91ca31df86f96b93b6
static/js/main.d08b0b92.chunk.js,1600610259640,65a9cdf47c4edeafe51d9e655642db11a3fe75f5babe4308442574d5bbddf1f8
static/js/2.e2177470.chunk.js.map,1600610259650,59878a444bbf12584fda40d5e5471190d9098f010e4ad17d4ee7a791a53addcd
73 changes: 14 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,23 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Green Machine

## Available Scripts
Green Machine is a web app that helps you calculate the carbon impact of your computations through fun and interactive visualizations.

In the project directory, you can run:
![Screenshot of Green Machine home page](./images/greenmachine-home.png "Green Machine home page")

### `npm start`
The project is built with React, styled-components, and uses data from [TOP500](https://www.top500.org/), [EPA](https://www.epa.gov/energy/greenhouse-gas-equivalencies-calculator), [MLCO2](https://github.com/mlco2/impact/tree/master/data), and [OpenGenus IQ](https://iq.opengenus.org/floating-point-operations-per-second-flops-of-machine-learning-models/).

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
### Features

The page will reload if you make edits.<br />
You will also see any lint errors in the console.
- Calculate the carbon emissions from your high performance computing services, get insights on how to reduce your carbon impact, and see the data in interactive visualizations.
- Compare the energy efficiency of leading supercomputers such as MIT's Satori with other systems including your own.
- ...

### `npm test`
![Screenshot of Green Machine home page](./images/greenmachine-calculate1.png "Green Machine home page")
![Screenshot of Green Machine home page](./images/greenmachine-calculate2.png "Green Machine home page")
![Screenshot of Green Machine home page](./images/greenmachine-calculate3.png "Green Machine home page")

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.
## Usage

### `npm run build`
Run `npm install` and `npm start` to launch the app locally. `npm run build` to build a production ready copy.

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.

### `npm run 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

### `npm run build` fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
Visit [https://green-compute-challenge.web.app/compare](https://green-compute-challenge.web.app/compare) for a live demo of this project.
37 changes: 0 additions & 37 deletions firebase-debug.log

This file was deleted.

4 changes: 0 additions & 4 deletions firestore.indexes.json

This file was deleted.

9 changes: 0 additions & 9 deletions firestore.rules

This file was deleted.

1 change: 0 additions & 1 deletion functions/.gitignore

This file was deleted.

9 changes: 0 additions & 9 deletions functions/index.js

This file was deleted.

Loading

0 comments on commit d82949b

Please sign in to comment.