QuickNote

A lightweight application designed for creating and managing notes. It provides a convenient way to jot down and organize your thoughts, ideas, and reminders. With a clean and intuitive interface, this app focuses on simplicity and efficiency.

Live preview

You can try live preview here: https://quick-note-steel.vercel.app

Credentials:

Email	Password
live.preview@gmail.com	RnDfTCZW6N58uEkJ

Technology stack

Technology stack used to create this application:

Technology	Usage
TypeScript	Programming languge
React	User Interface Library
Next.js	Framework & SSR
TailwindCSS	CSS Framework
Storybook	UI Component Development
TanStack Query	Data Fetching & State Management
React Hook Form	Forms Handling
PWA	Progressive Web App
tRPC	Type-Safe Backend API
Prisma	Database ORM
NextAuth.js	Authentication Library
PostgreSQL	Relational Database
Docker	Containerization Platform
Vitest	Testing Framework

Installation and usage

Installation

1. Clone the repository:

   git clone https://github.com/xStrixU/quick-note.git

2. Navigate to the project directory:

   cd quick-note

3. Install dependencies:

   pnpm install

Usage

Usage is different depending on the selected mode: development or production.

Development mode:

1. Copy the .env.example file to the .env.development.local file
2. Fill the environment variables
3. Run the application in development mode:

   pnpm dev

Production mode:

1. Copy the .env.example file to the .env.production.local file
2. Fill the environment variables
3. Build the application:

   pnpm next:build

4. Run the application in production mode:

   pnpm start

Preview

Write notes:

Invite other people:

Share notes:

License

MIT License, see LICENSE.