Skip to content

real-zephex/BasicNotes

Repository files navigation

Basic Notes

Basic Notes is a simple and intuitive note-taking application built with React and Next.js. It allows users to create, edit, and manage their notes effortlessly. The application saves notes locally, ensuring quick access and offline functionality.

Features

  • Create New Notes: Easily create new notes with a click of a button.
  • Edit Notes: Modify your existing notes with a simple and clean interface.
  • Local Storage: Notes are saved locally, ensuring they are always accessible even without an internet connection.
  • Responsive Design: The application is designed to work seamlessly on different screen sizes.

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/basic-notes.git
    cd basic-notes
  2. Install the dependencies:

    npm install
    # or
    yarn install

Running the Application

  1. Start the development server:

    npm run dev
    # or
    yarn dev
  2. Open your browser and navigate to http://localhost:3000 to see the application in action.

Usage

Creating a New Note

  • Click the + button to create a new note. A new text area will appear where you can start writing your note.

Editing a Note

  • Click the edit icon (pencil) next to a note to start editing. You will be redirected to an editing area where you can modify the content of your note.

Saving Notes

  • Notes are saved automatically to local storage as you type. There is no need for manual saving.

Project Structure

  • components/: Contains the main UI components of the application.
    • addNewFiles.tsx: Component for adding new notes.
    • EditArea.tsx: Component for editing notes.
    • SideBar.tsx: Sidebar component displaying the list of notes.
  • config/: Contains configuration files for local storage operations.
    • saveToLocal.ts: Utility for saving data to local storage.
    • LoadFromLocal.ts: Utility for loading data from local storage.
  • public/: Static files and assets.
  • styles/: CSS and styling files.
  • pages/: Next.js pages and routing.
  • app/: Main application configuration and providers.

Contributing

Contributions are welcome! If you have any ideas or suggestions to improve the application, feel free to open an issue or submit a pull request.

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-branch.
  3. Make your changes and commit them: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature-branch.
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Contact

For any questions or inquiries, please contact me at your.email@example.com.


Thank you for using Basic Notes! We hope it helps you stay organized and productive.