Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 3.17 KB

README.md

File metadata and controls

82 lines (57 loc) · 3.17 KB

Chaddon v0.2.0

alt text Heroku

Chaddon is a browser extension that detects an active tab’s url and connects you with other users currently browsing the same domain to a dynamic chatroom.

This project has been developed and maintained by Michael Pierre, Evan Davies, Geoff McCollam and Marco Beltempo

Although Chaddon is still in its early stages, the team plans to have the extension publicly available in the Chrome Webstore by late April 2018.

For now feel free to download the source code to test the extension locally or try the demo over at app.chaddon.ca


Chrome Extension Installation

  1. Download the .zip or .tar file
  2. Save the file to your local machine
  3. Extract the downloaded folder to the current directory
  4. Open a Google Chrome Browser
  5. Enter chrome://extensions/ in the address bar
  6. Make sure Developer Mode is checked
  7. Click Load unpacked extension...
  8. Navigate to the downloaded package and select the chaddon/browser_extension folder
  9. Chaddon 0.2.0 will display in your list of extensions

Build and Run

For more detailed information visit our Development-Environment-Setup wiki.

Getting the sources

git clone https://github.com/marcobeltempo/chaddon

Prerequisites

  • git
  • Node.JS, >= 8.9.1, < 9.0.0
  • npm v5.5 and up
  • Google Chrome v65.0 and up
  • pgAdmin 4 v2.1 (optional)
  1. cd chaddon
  2. npm install

Build

From a terminal, where you have cloned the Chaddon repository, execute the following command to run the nodemon server:

npm start

It will do an initial full build and then watch for file changes, compiling those changes incrementally, enabling a fast, iterative coding experience.

Run

To test the changes you launch a development version of the Chaddon extension

  1. Enter chrome://extensions/ in the Chrome address bar
  2. Enable Developer Mode
  3. Click Load unpacked extension...
  4. Navigate to the downloaded package and select the chaddon/browser_extension folder
  5. Enable Chaddon 0.2.0 in your extension list
    • Note the localhost server must be running without any errors

Scripts

  • npm start - uses nodemon to start the server and watch for any changes
  • npm test - executes eslint + prettier
  • npm run test:lint:fix - automatically fix any styling and validation errors. (Double check your changes)

Authors


License | Privacy Policy