AnkurChunekar/VelNotes

VelNotes is a note taking app for taking notes and organising them.

VELNotes

VelNotes is a note taking app for taking notes and organising them.
Live Website · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Built With
3. Features
4. How To Run Locally
5. Folder Structure
6. Contributing
7. Contact

About The Project

Inspiration strikes anywhere, VelNotes helps you capture, organize and save you ideas, across all platforms.

(back to top)

Built With

• ReactJS
• React Router
• Velocity UI
• Mockbee
• React Toastify
• Font Awesome

(back to top)

Features

• Auth Management
  • Login
  • Signup
  • Logout
• Notes Management
  • Crud on Notes
  • Note can have text as well as image
  • User can add color to the note
• Archive / Trash Functionality
  • User can add note to Archive / Trash
  • Note can be permanently deleted from trash
• Labels Management
  • User can add a Label to any note
  • New labels can also be created
• User can add between 5 themes of his app
• Filter Videos by Labels
• Sort Videos by Priority and Date
• Search Notes by Title as well as description

(back to top)

How To Run Locally

• Fork the project
• Run npm install
• Run npm start to run the project on your localhost

(back to top)

Folder Structure

- /public
- /src
   - /assets
   - /backend
   - /components
   - /context
   - /helpers
   - /pages
   - /reducers
   - App.css
   - App.js
   - index.css
   - index.js
   - server.js
- package-lock.json
- package.json
- README.md
- yarn.lock

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

(back to top)

Contact

• Twitter - @ankur_chunekar
• Linkedin - @ankurchunekar
• Website - ankurchunekar.netlify.app
• Hashnode - @ankurchunekar

(back to top)