Skip to content

Repository files navigation

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:

EmailPassword
live.preview@gmail.comRnDfTCZW6N58uEkJ

Technology stack

Technology stack used to create this application:

TechnologyUsage
TypeScriptProgramming languge
ReactUser Interface Library
Next.jsFramework & SSR
TailwindCSSCSS Framework
StorybookUI Component Development
TanStack QueryData Fetching & State Management
React Hook FormForms Handling
PWAProgressive Web App
tRPCType-Safe Backend API
PrismaDatabase ORM
NextAuth.jsAuthentication Library
PostgreSQLRelational Database
DockerContainerization Platform
VitestTesting 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

image

Write notes: image

Invite other people: image

Share notes: image

License

MIT License, see LICENSE.

About

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages