This repository contains the frontend code for the Punotes application. It's a React application built with Vite, TypeScript, and Tailwind CSS.
These instructions will get you a copy of the project up and running on your local machine for development and testing.
- Node.js and npm (or yarn) installed.
- Docker and Docker Compose installed.
-
Clone the repository:
git clone https://github.com/f0rsakeN-afk/punotes cd frontend
-
Install dependencies:
npm install
-
Start the development server:
npm run dev
This will start a Vite development server. You can access the application at
http://localhost:5173
(or the port specified by Vite).
-
Build the application:
npm run build
This will create a production-ready build in the
dist
directory.
-
Build and run the Docker image:
docker-compose up -d --build
This will build the Docker image and start a container running Nginx to serve the application. Access the application at
http://localhost:8080
. -
Stop the Docker containers:
docker-compose down
To run the linter:
npm run lint
To deploy this application to a platform like Vercel or Netlify, you'll need to build the application using npm run build
and then deploy the contents of the dist
folder. Consult the documentation for your chosen platform for specific deployment instructions.
- React
- Vite
- TypeScript
- Tailwind CSS
- Redux Toolkit
- React Router
- Lucide Icons
- Radix UI