ahertig / coder-notes

Capstone Project of GHA Team-3

README.md

GHA Capstone project: "Coder Notes"

Alyssa Hertig, Dorothy Moore, Ksenia Mikhailovskaya, and Zhengshi Zhao

Coder Notes is a free, open-source notebook designed for coders.

Popular note-taking apps aren’t exactly coder-friendly. It takes extra time to separate code from regular notes, and searching for particular snippets can be a pain. Coder Notes fixes these problems.

The Coder Notes interface formats code appropriately with Angular Markdown and HighlightJS, which is a huge leg up on Evernote, where code is formatted exactly as the rest of the text. Coders can organize notes by tag or notebook and—rather than toggling to a repl.it window—can execute code directly within the note with the help of Tonic, a sandboxed NodeJS environment.

Deployed at

www.codernotes.us

Features

• Share notes with friends
• Make them publicly searchable to the world
• Export notes as Gists
• Save code snippets from any website with the Coder Notes Chrome Extension.

Additional NPM modules and dev tools used:

• Marked: https://www.npmjs.com/package/marked
• Angular Marked https://www.npmjs.com/package/angular-marked
• Angular Highlight.js: https://www.npmjs.com/package/angular-highlightjs
• Tonic https://tonicdev.com/
• Font Awesome: https://www.npmjs.com/package/font-awesome

Chrome Extension

Installation instructions for development version

https://developer.chrome.com/extensions/getstarted

1. Visit chrome://extensions
2. Ensure that the Developer mode checkbox is checked
3. Click "Load unpacked extension…" and load the "chrome-extension" folder from this repo

Installation instructions for production version

Visit the Chrome Web Store for the production version of the extension.

Tips on markdown

Markdown Cheatsheet: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

coder-notes's Issues

Change font to sans serif font of some kind

Change gold hover color to something cleaner

First and Last name should not be required on sign up