Snap Note

Snap Notes is a web application built with Next.js that allows users to create, store, manage, and share notes. The application provides two types of notes: public notes and private notes, giving users the option to control the visibility of their notes. This README provides an overview of the project and instructions for setting up and running the frontend application.

Screenshots

Table of Contents

• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

Features

Snap Notes offers the following key features:

1. User Authentication: Users can sign up and log in to the application to access their personalized notes dashboard.
2. Create Notes: Users can create new notes with a title and content.
3. Store and Manage Notes: All notes are stored securely in the database and can be managed through the user interface.
4. Public and Private Notes: Users have the option to mark notes as public (shareable) or private (only visible to themselves).
5. Share Notes: Public notes can be shared with others through unique links generated by the application.
6. Note Editing: Users can edit their existing notes to update the content or visibility settings.
7. Responsive UI: The application is responsive and optimized for various devices, including desktops, tablets, and mobile phones.

Technologies Used

The Snap Notes frontend is built using the following technologies:

• Next.js: A React framework for building server-side rendered (SSR) and statically generated (SSG) applications.
• React: A JavaScript library for building user interfaces.
• Tailwind CSS: A utility-first CSS framework for rapid UI development.
• Axios: A promise-based HTTP client for making API requests to the backend.

Getting Started

Follow the instructions below to set up the Snap Notes frontend on your local machine.

Prerequisites

• Node.js: Make sure you have Node.js installed. You can download it from the official website: https://nodejs.org

Installation

1. Clone the repository:

git clone https://github.com/lakshaykamat/snap-note.git
cd snap-note

2. Install dependencies:

npm install
# or
yarn

Usage

1. Start the development server:

npm run dev
#or
yarn dev

2. Open your web browser and go to http://localhost:3000 to access the Snap Notes application.

3. Sign up or log in to your account to start creating and managing notes.

Contributing

Snap Notes is an open-source project, and contributions are welcome! If you find a bug, have an enhancement suggestion, or want to add new features, feel free to open an issue or submit a pull request.

Before making significant changes, please discuss your ideas in the project's issue tracker to ensure they align with the project's goals.

License

This project is licensed under the MIT License.

Thank you for using Snap Notes! If you have any questions or need assistance, please feel free to reach out to us or create an issue in the repository. Happy note-taking!