An amazing notes app that can help you keep a track of your notes and essential tasks.
The app is a Ruby On Rails based web application
Link to hosted application:
https://stark-savannah-91363.herokuapp.com/
- Addition/Deletion/Updation of Notes
- App supports addition of images by both markdown and separate image upload
- Sort the posts/notes
- Filter by user email
- Information stored about notes
- Title
- Label
- Content
- Addition of Admin Panel
- Filtering on the basis of Label
- Filtering on the basis of Date
- Searching the notes based on substring matching
- Support for 9 different tags - Medium Priority, Non-critical, Work, Trackback, Family, Deadline, In Progress, Important, Priority
- User Authentication
- Validation on the naming of the notes
- Support for Markdown
- Link Highlighting
- Smooth Scroll
Follow the steps below to run the project.
- Clone the Repository
$ https://github.com/singhsanket143/Hemlet-Assignment-App.git
- Install the gems
$ bundle install
- To set up the tables in the database
$ rake db:migrate
- We always have default data that we want to have in our application for testing purposes. The seed command exists to automate this process. To do that use,
$ rake db:seed
- Run the rails server using the command line simply using,
$ rails server
- Run the application on http://localhost:3000/
The main purpose of Admin Panel is to add/remove the labels to the notes and keep a track of the current users of the app.
To access the admin panel go to the route '/admin' Credentials for default admin: Email: 'admin@example.com' password: 'password'
Each note can be viewed, edited and deleted depending on the requirements of the user.
The notes can be filtered on the basis of label assigned to them. Simply write the name of the required tag and press Apply Filters. The required notes will be displayed. Eg: Display the notes which have the tag Deadline.
In order to filter the notes, on the basis of date, write the start date and the end date and press Apply Filters.
Notes can be searched on the basis of the substring. Write the name of the notes you want to in the search bar and press the button search.
To add a new note click on Create new note. Add the title and the description of the note. You can also add labels such as Medium Priority, Non-critical, Work, Trackback, Family, Deadline, In Progress, Important, Priority
To edit a note, simply click on the edit note button corresponding to the note that you want to edit.
To view a particular note, click on the button View Note