BUMBAIYA / kanban-full-stack

Kanban

Welcome to Kanban, project built with React.js, Tailwind CSS and TypeScript.

Streamlining your workflow and project management has never been easier. With a clean and intuitive user interface crafted using ReactJS, you'll experience seamless navigation and real-time updates as you manage tasks and projects.

🛑 IMPORTANT

This project is in its early stages, so the tech stack may be subject to change throughout the development process.

🖥️ Technologies Used

• 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.

🛠️ Development setup

Steps to locally setup development after cloning the project.

NOTE: Run every command in project root

1. Clone repo

   git clone https://github.com/BUMBAIYA/kanban-full-stack.git

2. Navigate to the project directory

   cd kanban-full-stack

3. Install dependencies

   npm run install

4. Recommended : Use Docker to build the PostgreSQL server if you don't want to install postgres locally

   Copy and paste variables from .env.example into .env in project root.Do not edit the env variables

   Copy and paste variables from Docker part from packages/server/.env.example into packages/server/.env Do not edit the env variables

   Run 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

5. Optional : If you have PostgreSQL installed locally

   Copy and paste variables from Local ProstgreSQL part from packages/server/.env.example into packages/server/.env

   Edit the DB_USER and DB_PASSWORD with your local postgreSQL credentials

   Generate 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

License

Licensed under the MIT license

---