this is simple notes app with next js, hono, cleark-auth, react-query and drizzle orm
A feature-rich notes application built with Next.js, Hono, Clerk for authentication, React Query for data fetching, and Drizzle ORM for database management. This app allows users to create, edit, delete, and categorize notes easily.
To get a local copy of this project up and running, follow these steps.
Clone the repository:
git clone https://github.com/mo-hassann/nextjs-notes-app.git
cd nextjs-notes-app
Install dependencies:
Using npm:
npm install
Using yarn:
yarn install
Using Bun:
bun install
Set up environment variables:
Create a .env
file in the root directory and add the following variables:
# next
NEXT_PUBLIC_APP_URL=http://localhost:3000
# cleark auth
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=************
CLERK_SECRET_KEY=***********
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
#hono with clerk
CLERK_PUBLISHABLE_KEY=**************
# database
DATABASE_URL=https://**************
DATABASE_SECRET=************************
DRIZZLE_DATABASE_URL=postgresql://*******:*********************
Run database migrations:
Ensure your database is running and then run:
Using npm or yarn:
npm run migrate
# or
yarn migrate
Using Bun:
bun run migrate
Start the development server:
Using npm or yarn:
npm run dev
# or
yarn dev
Using Bun:
bun dev
Open http://localhost:3000 to view the app in your browser.
npm run dev
, yarn dev
, or bun dev
.npm run build && npm start
, yarn build && yarn start
, or bun run build && bun start
.The API documentation for this application is available at http://localhost:3000/api/docs. It details all endpoints and their usage.
We welcome contributions to this project. Please follow these steps to contribute:
git checkout -b feature/your-feature-name
).git commit -m 'Add some feature'
).git push origin feature/your-feature-name
).Please make sure to update tests as appropriate.
Distributed under the MIT License. See License for more information.