/nucleus-notes

A useful notes application to keep track of daily notes

Primary LanguageRuby

README

Codeship Status for ohboyd/nucleus-notes

Nucleus Notes

A useful notes application to keep track of daily notes, and all the tasks on your todo list.

Fun Features

  • Sometimes our list is too long to manage, so there's a feature that becomes active when we start to accumulate tasks in app. If you're unsure what task to do next, Nucleus will do the thinking for you. Simply choose the Randomize button once your tasks start piling up, and you can save your brainpower for the work instead of wearing yourself out over the simpler things. Keep in mind, you need to record at least five tasks first!

  • In 2019, for yet another year, the most common leaked password was '123456' with at least 23.2 million uses according to this study done by the National Cyber Security Center in the UK. So it's critical that your private thoughts stay private, and Nucleus can do that for you. Easily integrate with Two Factor Authentication and put on your tinfoil hat. No one's reading your grocery list without your say-so.

  • The text field where you enter your notes support full rich text editing, and you can upload as many files as you want! Keep track of everything in one place!

  • Thanks to ajax, it's possible to check off the individual notes as you're finished with them from the index page. Also, using some of Bootstrap's new icons, you can see their behavior change on hover.

  • Furthermore, when archiving those notes from the index page, you'll be able to see a simple modal popup with a random celebratory GIPHY, just to add a little excitement to your life!

  • Like a note you've created, like a todo list, or something that came out more poignant than expected? Feel free to email the note to yourself, or maybe that relative you've been avoiding for far too long now. Momma misses you, after all!

Technologies

  • Rails 6.0

  • Ruby 2.5

  • The deployment pipeline moves from GitHub -> CodeShip CI -> Heroku

  • AWS S3 & Active Storage for imbedded images and other attachments

  • Action Text for user-friendly Rich Text formatting

  • Webpacker for js assets, Sprockets for the SCSS and images

  • Bootstrap for the design and icons (along with popper and jquery)

  • Ajax for asynchronous updating, with no page refresh

  • Validations are unit tested within rspec model tests which take advantage of factory bot and faker

Worthwhile Gems

  • devise for robust authentication

  • devise-authy for 2FA (more security and privacy)

  • pundit for simple, scalable authorization

  • dotenv for loading environment variables easily

  • faker to generate fun mock data for the seeds

  • rspec for the test suite

  • factory bot to generate quasi-fixtures for easy testing

Glamour Shots

landing page

sign up

authy verification

index page

show page

new page