NoteNice is a web app for Flatiron School written in Ruby using Sinatra, ActiveRecord, SQLite3, and PostgreSQL.
NoteNice is a collaborative note-taking app for sharing and editing notes with your friends that uses
redcarpet markdown formatting. Currently, NoteNice supports copying notes as well as making public or private notes. Future features will include more robust git-like version control to keep everyone on the same page, including requesting editing permission and saving your favorites.
Using the web
This app has been deployed to Heroku, available at www.notenice.xyz. Deployment environments and groups have been configured using PostgreSQL adapters in this repo, although SQLite3 is still being used for development.
Using a localhost
Shotgun requires Linux, Mac OSX or Linux VM on Windows. Other than the gems listed in this app’s Gemfile, you will need to have Ruby installed on your local machine as well as the ability to install Ruby gems.
- SQLite3 (development)
- PostgreSQL (deployment)
Setting up for development
If you want to work on your local environment, you can start by forking and cloning this GitHub repo to your local machine, using the terminal.
Change directories into the repo directory and run the $bundle install command.
cd notenice bundle install
Run the $shotgun command to start an automatic reload version of rackup.
You can then navigate to the route displayed in the terminal. (E.g. http://127.0.0.1:9393)
After making any changes to the code, reload your browser window to make a new request and see your changes.
Navigate to the routes in
user_controller to create, read, and edit new
User objects and records as well as create, read, update and destroy
Note objects and records.
Bug reports and pull requests are welcome on GitHub at https://github.com/twwright/notenice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Looking for a specific way to contribute?
Check out the
Issues section with TODOs, bugs to fix, and planned features.
This project is licensed under the MIT License - see the LICENSE.md file for details