LiveKanban

A live kanban to manage projects, built with tinyhttp, Prisma, Liveblocks and Nuxt3.

What's inside?

This repository is a monorepo powered by Turborepo. It includes the following packages/apps:

Applications

• web: a Nuxt3 application
• api: a tinyhttp API application

Packages

• eslint-config-custom: eslint configurations
• tsconfig: tsconfig.jsons used throughout the monorepo

Utilities

• Tailwind & DaisyUI for CSS styles and UI components
• TypeScript for static type checking
• Jest for tests
• ESLint for code linting
• Commitizen for conventional commit enforcement

Getting started

Requirements

Name	Version
Node	14.0+
Docker	20.10+

Installation

To get the project started, clone this repository:

# With SSH
git clone git@github.com:IIM-Creative-Technology/NODEJS-SOCKETIO-IIM-DW1-PROPRE.git

# With HTTP
git clone https://github.com/IIM-Creative-Technology/NODEJS-SOCKETIO-IIM-DW1-PROPRE.git

Then install packages:

npm install

If you want to use it there is a development database ready with Docker compose:

docker-compose up -d

Then you need to run the prisma generate command:

# Navigate to the api app directory
cd apps/api
npx prisma generate

Development

To run the project for development use:

npm run dev

It will automatically run the Nuxt and Adonis apps on your localhost.

Build

To build the project use:

npm run build

Linting

All apps in the repository can be linted with:

npm run lint

Tests

Don't forget to test your code before sending a PR.

To run tests you can run:

npm run test

Contributing

Any help and contribution is welcome, feel free to submit issues and/or contribute to the project.

Please read through the contributing guidelines for more details.

License

Copyright (c) 2022 Antoine Puech, Florent Vigot, Samir Chalal, Colin Espinas.

Live Kanban is distributed under the MIT License. See the license for more details.