Skip to content

jasmineelkins/forget-me-not

Repository files navigation

Forget Me Not

Forget Me Not is a React/Rails web application that allows you to save articles to a custom reading list and receive them in an email newsletter. You choose when you want to read them: that week or by the end of the month. Live demo here.

Table of Contents

General Information

  • For my capstone project at the Flatiron School I wanted to build an app that was unique and functional, so I started thinking about the ways that I use technology and what could be improved. Something that immediately came to mind is the built-in reading list of our web browsers.
  • These built-in reading lists are not visually appealing. Everything is added to one list, with no option to set when you want to read an article. Forget Me Not allows you to choose when you would like to read the article and then receive your reading list as a newsletter sent at the end of each week and month. This way, you won't forget about the articles you've saved.
  • I built this project to solve an issue I've faced, and to challenge myself to design and build a fully functional app within 3 weeks. I used my foundation in React and Rails, and also learned how to build a Chrome extension, program custom web scrapers, and send formatted emails.

Technologies Used

  • React 18.1.0
  • Ruby 2.7.4p191
  • Rails 7.0.3
Ruby Gems:
  • bcrypt 3.1.7
  • watir 7.1.0
  • nokogiri 1.13.6
  • pg 1.3.5

Features

  • Save articles to your custom reading list
  • Receive as a formatted email newsletter
  • Can be used with Chrome extension ** in development mode only, see instructions below

Screenshots

Homepage + Extension

Homepage + Extension

Newsletter (viewed on website)

Newsletter

Newsletter (viewed as email)

Newsletter

Wireframe

Wireframe

Demo

Forget Me Not intro screen

Setup

To get started:

  1. Clone this repository
  2. Install dependencies
  3. Start rails server and start react app
cd forget-me-not
bundle install
rails s

cd client
npm install
npm start

Usage

Forget Me Not is designed to be used with a Chrome extension which can access the URL of the current tab. Click this link to access the extension repository and follow the installation instructions in the README. You will need to use Chrome Dev and add the extension in Developer mode.

Alternatively, there is a form embedded at the top of the Reading List page where you can enter the URL of the page you want to save. This will achieve the same results without having to install the Chrome extension!

Project Status

Project is: in progress.

Room for Improvement

Room for improvement:

  • Forget Me Not is deployed on Heroku, but the extension can not yet interact with that version. There is also a bug while saving articles using the embedded form on Heroku- this is top priority to fix.
  • Adding sort & filter options to the reading list to allow for more customization.

To do:

  • Set up automatic email delivery according to frequency.
  • Include horoscope and local weather based on user information.
  • Add web scrapers for additional sources.
  • Publish the extension in the Chrome store.

Acknowledgements

  • This project was inspired by an idea from ideasgrab.com:

    "an app that takes the articles you saved to your reading list and sends them to you as a printed newspaper"

  • Many thanks to my instructor at Flatiron, Chett Tiller: for teaching me a solid foundation in React and Rails, and supporting and encouraging me not only on for this project, but throughout the entire 15-week program.

Contact

Created by Jasmine Elkins - feel free to contact me!

--

Use the app here: https://jasmineelkins-forget-me-not.herokuapp.com/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages