Giter VIP home page Giter VIP logo

sticky-note's Introduction

Sticky Note Application

This application allows users to create, manage, and organize their notes with a modern and intuitive interface. Built with React and Firebase, this app features secure user authentication, robust note management, and advanced filtering and organization options.

Deployment Link

https://sticky-note-green.vercel.app/

Features

1. User Authentication

  • Secure Login System: Users can sign in to access their personalized notes, ensuring that their data is secure and private.

2. Note Management

  • Add Notes: Create notes with customizable properties:
    • Group: Categorize notes under different groups.
    • Text: Input the main content of the note.
    • Color: Assign a color to each note for easy identification.
  • Edit Notes: Update existing notes, including changing the group, text, or color.
  • Delete Notes: Remove notes that are no longer needed.

3. Filtering and Organization

  • Filter Notes: Quickly find relevant notes by filtering based on group or color.
  • Drag and Drop: Rearrange notes freely within the interface using drag-and-drop functionality.

4. Hosting

  • Deployment: The application is hosted on Vercel, making it accessible online.

Optional Features (Bonus Points)

  • Reset Position to Grid: Users can reset the position of all notes to a default grid layout.
  • Remember Last Position: The application remembers the last position of each note when the user logs out and logs back in.
  • Group View: View all notes within a specific group in a consolidated manner.

Technology Stack

  • Frontend: React
  • Backend: Firebase (for authentication and database)

Setup and Installation

To run the application locally, follow these steps:

  1. Clone the Repository

    git clone https://github.com/9582anupam/Sticky-Note
    cd Sticky-Note
  2. Install Dependencies

    npm install
  3. Configure Firebase

    • Create a Firebase project and obtain your Firebase configuration details.
    • Add your Firebase configuration to a .env file in the root directory with the following format:
    REACT_APP_FIREBASE_API_KEY=YOUR_API_KEY
    REACT_APP_FIREBASE_AUTH_DOMAIN=YOUR_AUTH_DOMAIN
    REACT_APP_FIREBASE_PROJECT_ID=YOUR_PROJECT_ID
    REACT_APP_FIREBASE_STORAGE_BUCKET=YOUR_STORAGE_BUCKET
    REACT_APP_FIREBASE_MESSAGING_SENDER_ID=YOUR_MESSAGING_SENDER_ID
    REACT_APP_FIREBASE_APP_ID=YOUR_APP_ID
    REACT_APP_FIREBASE_MEASUREMENT_ID=YOUR_MEASUREMENT_ID
    REACT_APP_FIREBASE_DATABASE_URL=YOUR_DATABASE_URL
  4. Start the Application

    npm start

    The app will be available at http://localhost:3000

Contributing

Feel free to contribute to this project by submitting pull requests or opening issues. We welcome improvements and suggestions!

License

This project is licensed under the MIT License.

Author

sticky-note's People

Contributors

9582anupam avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.