francoabaroa / markable

Markable

App

A Google Chrome Extention to help you markup any html page on the web and share with your group of family and friends

Team

• Product Owner: Lucas Becker
• Scrum Master: Stephen Cefali
• Development Team Members: Franco Abaroa, Wallace Luk

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

For local implementation;

Start local database:

From within the root directory:

npm start

Extension:

To add the extension to your chrome browser, go to Settings > Extensions, check the 'Developer mode' box. Click 'Load unpacked extension...' and load the whole extension folder in the project directory.

Head to local host: 127.0.0.1:3000

Requirements

• Node
• PostgreSQL

Documentation

[Get Started Here]

Requirements

• Stack used: PostgreSQL, Angular, React, Express.
• Deployment tool: DigitalOcean

Development

Installing Dependencies

From within the root directory:

npm install

Testing

npm test

Linting The Code

npm lint

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.