Table of Contents
This is Reliant – a browser extension that enhances your article reading experience.
In 2021, an average of 5,200 articles are produced by major news outlets every day. It feels like there’s so much information out there that makes it harder for one person to decide what’s true and what’s not. In a world full of misinformation, this project aims to spark discussion amongst readers, allowing them to make the best decision regarding the reliability of their article. In short, we hope to simplify the process of gathering information about the article's credibility.
We do this by:
- Author Reliability Score
- Author Background Information
- Comments
- Notes
- Highlights
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
You'll need npm to run this project.
npm install npm@latest -gFirst, install the packages for the client.
npm install
Optional: If you're planning on running a development server (Must have mongoDB access)
cd backend/
npm install
Optional: If you're planning on running a development server
create a .env on the root level and add your MongoDB connection string
Example:
MONGODB_URI = mongodb+srv://username:password@cluster0-jtpxd.mongodb.net/admin
To run the extension using a development server on localhost:4000 like:
npm run dev
To run the extension using the production server:
npm run prod
To run the extension with the client only:
npm start
Load your extension on Chrome with the following:
- Access
chrome://extensions/ - Check
Developer mode - Click on
Load unpacked extension - Select the
buildfolder.
Here is an example of all the features Reliant can bring to you!
Note: Reliant can only be used on these sites:
- https://www.nytimes.com/
- https://www.theverge.com/
- https://www.wired.com/
- https://www.cnn.com/
- https://www.vox.com/
See the open issues for a list of proposed features (and known issues).
All issues are kept under the Issues tab. If you find anything you'd like to
add or see fixed, add it there.
To make a change:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Pull requests should be reviewed by at least one active contributor. Please include screenshots with any frontend changes.
Distributed under the MIT License. See LICENSE for more information.
Philippe Desrosiers - Linkedin - pdesrosiers3@gatech.edu
Cooper Meitz - Linkedin - cmeitz3@gatech.edu
Youssef Asaad - Linkedin - yasaad3@gatech.edu
Avinash Sivakumar - Linkedin - asivakumar36@gatech.edu
Andrew Bondurant - Linkedin - abondurant30@gatech.edu
Project Link: https://github.com/Phildesro123/Reliant