NoteScape

Your personal notes taking app

Features

• User Authentication: Utilizes Clerk for secure user authentication.
• Note Management: Create, edit, delete, and organize your notes effortlessly.
• Real-time Updates: Changes are instantly synced across devices thanks to CoveX DB.
• Responsive Design: Enjoy a seamless experience on desktop, tablet, and mobile.

Getting Started

Prerequisites

• Node.js and npm installed on your machine.
• A CoveX DB account for real-time database functionality.
• A Clerk account for user authentication.

Installation

1. Clone this repository:

git clone https://github.com/amandeepsirohi/NoteScape.git

2. Install dependencies:

cd NoteScape
npm install

3. Create a .env.local file in the root directory and add the following environment variables:

COVEX_DB_API_KEY=YOUR_COVEX_DB_API_KEY
CLERK_API_KEY=YOUR_CLERK_API_KEY
CLERK_FRONTEND_API_KEY=YOUR_CLERK_FRONTEND_API_KEY

Replace YOUR_COVEX_DB_API_KEY, YOUR_CLERK_API_KEY, and YOUR_CLERK_FRONTEND_API_KEY with your actual CoveX DB and Clerk API keys.

Start the server

npx convex dev

Start the client

npm run dev

Visit http://localhost:3000 in your browser to start using the Notescape clone.

Tech

• Next.js: A React framework for building server-rendered applications.
• CoveX DB: A real-time database service for synchronizing data across devices.
• Clerk: A user authentication service providing secure login and signup flows.
• TypeScript: A superset of JavaScript that adds static types.
• Tailwind CSS: A utility-first CSS framework for quickly building custom designs.

Contributions

Feel free to contribute by opening issues, providing feedback, or creating pull requests. Any help is greatly appreciated.