Skip to content

Community Based Article Annotating Chrome Extension

Notifications You must be signed in to change notification settings

Char-Mizzle/cbaace

Repository files navigation

cbaace

How to build dist folder to be imported for Chrome Extension

  1. cd client (move to client directory)
  2. npm install (to install dependencies)
  3. npm run build (this will create dist folder)
  4. Open Chrome Extension page in developer mode and select load unpacked

How to run the server

  1. npm install
  2. npm run dev (this will run index.js with nodemon which will auto recompile on changes)

Config File

This file will be discarded from git repo in our final deployment

MongoDB Structure

Depending on our decision between annotion on the article vs on quotes, the structure will change

user{
    id
    username
    [refs to annotations]
}

article{
    [quotes{
        [refs to annotations]
    }]
}

annotation{
    ref to quote
    ref to author
    content
    upvotes
    downvotes
    *maybe sentiment info*
}

About

Community Based Article Annotating Chrome Extension

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •