This project is in its early stages, so the tech stack may be subject to change throughout the development process.
- React.js : React is a free and open-source front-end JavaScript library for building user interfaces based on UI components.
- Tailwind CSS : A utility-first CSS framework for rapid UI development.
- Prisma : Next-generation ORM, it provides a clean and type-safe API for submitting database queries.
- PostgreSQL : It is a highly stable database management system, which has high levels of resilience, integrity, and correctness.
- Express : An Express server is a fast and minimalist web application framework for Node.js, designed to simplify the creation of robust and scalable web applications and APIs.
- Socket.io : Socket.IO is a library that enables low-latency, bidirectional and event-based communication between a client and a server.
- Docker : Docker helps developers build, share, and run applications anywhere — without tedious environment configuration or management.
- TypeScript: A typed superset of JavaScript that provides enhanced tooling and developer productivity.
Steps to locally setup development after cloning the project.
NOTE
: Run every command in project root
-
Clone repo
git clone https://github.com/BUMBAIYA/kanban-full-stack.git
-
Navigate to the project directory
cd kanban-full-stack
-
Install dependencies
npm run install
-
Recommended
: Use Docker to build the PostgreSQL server if you don't want to install postgres locallyCopy and paste variables from
.env.example
into.env
in project root.Do not edit the env variablesCopy and paste variables from
Docker
part frompackages/server/.env.example
intopackages/server/.env
Do not edit the env variablesRun docker compose
docker compose up -d
Stop the docker kanban-server
docker stop kanban-server
Start the development Express server
npm run dev:server
Start the development ReactJs Application
npm run dev:app
Server will be running on
https://localhost:3000
App will be running on
http://localhost:5173
-
Optional
: If you have PostgreSQL installed locallyCopy and paste variables from
Local ProstgreSQL
part frompackages/server/.env.example
intopackages/server/.env
Edit the
DB_USER
andDB_PASSWORD
with your local postgreSQL credentialsGenerate prisma client
npm run db:generate
Migrate Database schmema
npm run db:migrate
Start the Express server
npm run dev:server
Start the ReactJs Application
npm run dev:app
Server will be running on
https://localhost:3000
App will be running on
http://localhost:5173
Licensed under the MIT license