https://github.com/glavin001/burntchrome

Software Engineering class project
https://github.com/glavin001/burntchrome

Last synced: about 1 month ago
JSON representation

Software Engineering class project

• Host: GitHub
• URL: https://github.com/glavin001/burntchrome
• Owner: Glavin001
• License: mit
• Created: 2016-01-21T18:13:31.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-06T14:43:10.000Z (about 9 years ago)
• Last Synced: 2025-02-05T15:54:10.956Z (3 months ago)
• Language: HTML
• Homepage: https://drive.google.com/open?id=0B5-qlJU7RXiNc2xfZjBYM1N2X2M
• Size: 1.01 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Burnt Chrome [![Build Status](https://travis-ci.org/Glavin001/BurntChrome.svg?branch=master)](https://travis-ci.org/Glavin001/BurntChrome)

> Class Project for CSCI 3428 Software Engineering

## About

### Documents

- [Risk Analysis](https://drive.google.com/open?id=1lOxLEEGWvbhaKKaLM5Oys0vn94d1937PmQm6UNcSkq8)

- [Requirements Specifications](https://drive.google.com/open?id=1k3z0ABU4Lxw3b5KyHMEdxxgWWG_033Yj4MgzTJdZ0QQ)

Documentation: http://blog.glavin.org/BurntChrome/docs/index.html

### Authors / Team Black

| [Evan Larose](https://github.com/LizardLeliel) | [Glavin Wiechert](https://github.com/Glavin001) | [Nathan Hernden](https://github.com/nhernden) | [Ziyun (Toby) Zhong](https://github.com/zhongziyun1993) |

| --- | --- | --- | --- |

| Software Tester | Project Leader, Lead Software Engineer | Lead Writer | Software Developer |

| ![evan](https://avatars3.githubusercontent.com/u/7256908) | ![glavin](https://avatars0.githubusercontent.com/u/1885333) | ![nathan](https://avatars0.githubusercontent.com/u/13204557) | ![toby](https://avatars1.githubusercontent.com/u/3355559) |

### Screenshots

| Login | Whitelist |

| --- | --- |

| ![image](https://cloud.githubusercontent.com/assets/1885333/13033161/d88a2382-d2e2-11e5-956c-314614778101.png) | ![image](https://cloud.githubusercontent.com/assets/1885333/13033158/d2d27bd8-d2e2-11e5-9d29-ad754e1e95ae.png) |

## Contributing

1. Install [Node.js & `npm`](https://nodejs.org/)

2. Install the dependencies using `npm`:

 ```bash

npm install -g bower

npm install

```

3. Watch for file changes and compile the extension:

 ```bash

npm start

```

4. To load your extension in Chrome, open up [`chrome://extensions/`](chrome://extensions/) in your browser and click `Developer mode` in the top right. Now click `Load unpacked extension…` and select the `extension/` directory. You should now see your extension in the list.

 ![load extension](http://i.stack.imgur.com/vJexl.png)

 When you change or add code in your extension, just come back to the [`chrome://extensions/`](chrome://extensions/) page and reload the page. Chrome will reload your extension.

 I recommend that you install [`Extensions Reloader`](https://chrome.google.com/webstore/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid).

5. Profit

### Developing

We are using ES6 which is compiled down to ES5.

See https://github.com/lukehoban/es6features for a detailed list of features supported by ES6.

#### Commands

- `npm run compile`: Compile `extension/src/` to `extension/dist/` directory.

- `npm start` (or `npm run start`): Watch for file changes in `extension/src/` directory and compile changes to `extension/dist/` directory.

- `npm run docs`: Build documentation for source code to `docs/` directory. Open `docs/index.html` in your web browser to view after built.