Keeper

It is a simple note taking app where user can write their thought or anything they want.

Table of Contents

• App features
• Future Planning
• Technology Used
• Run it Locally
• Screenshots
• Necessary Links

Features

In this app user get some features such as

• create note
• delete note
• update existing note
• search specific note

Future Planning

In future, some features can be added such as

• update UI for more friendly user experience
• create note with checklist and upload photo
• create folder to store related notes
• add level to note

Technology Used

• NextJs v16
• React v19
• Tailwindcss v4

Run it Locally

Please follow the below instructions to run this project in your machine:

1. Clone this repository

       git clone https://github.com/sagormajomder/keeper.git

2. To run below command, your machine must have install nodejs

• Install project dependencies

      npm install

• Set up environment variables: Create a .env file in the root directory and add the following environment variables:

  // Example .env file
  NODE_ENV=development
  NEXT_PUBLIC_API_URL=http://localhost:3000
  MONGODB_URI=<get from mongodb>
  

• Run the project

      npm run dev

The app will be available on http://localhost:5173 by default.

Screenshots

• UX design Diagram

• Component Breakdown diagram

• Component Hierarchy diagram

Necessary Links

• Repository link: Github repository
• Design link: Figma
• Live link : keeper live