Keeper - Note Taking App

Screen.Recording.2023-09-12.at.10.21.17.AM.mp4

Keeper is a simple and intuitive note-taking app built with Next.js. It allows users to create, edit, delete, and manage their notes conveniently. Whether you need to jot down important information, ideas, or to-do lists, Keeper has got you covered

Features

• User Authentication: Users can sign in or create a new account.
• Note Management: Create, edit, and delete notes with ease.
• Optional Title: Notes can have a title, but it's not mandatory.
• Profile Options: Users can access options like creating a new note or logging out.
• Persistent Data: Notes are stored locally and will be available across sessions.
• User-Friendly: Intuitive and clean user interface for a smooth experience.

Getting Started

Follow these steps to get Keeper up and running on your local machine.

Prerequisites

• Have Node.js installed on your system.

Installation

1. Clone the repository:

git clone git@github.com:chayboats/keeper.git

2. Navigate to the project directory:

cd keeper-app

3. Install the dependencies:

npm install

4. Start the development server:

npm run dev

5. Open your browser and visit http://localhost:3000 to access the app.

Usage

1. On the start page, click the "Sign In" button to access the sign-in page.
2. From the sign-in page, you can sign in with your credentials or navigate to the "Create Account" page to register.
3. After signing in or creating an account, you'll be directed to the home page where you can start taking notes.
4. Create a new note by entering content in the note editor. Adding a title is optional.
5. Edit, delete, or delete all notes using the provided options.
6. Click your profile picture to access the "Create New Note" option or log out.
7. When you log back in, your notes from the previous session will be available.

Technologies Used

• Next.js - A React framework for building web applications.
• React - A JavaScript library for building user interfaces.
• Local Storage - Used to store and persist user notes.
• CSS - Styling the user interface.

Acknowledgments

Special thanks to the Next.js and React communities for their invaluable resources and support during the development of this app.

Contact Me

If you have any questions, comments, or suggestions, please don't hesitate to reach out. I'd love to hear from you!

Chaley Boatmon

• Email: chaleyboatmon@gmail.com
• GitHub: chayboats

Thank you for visiting my repository!