|
| 1 | +# LiveKanban |
| 2 | + |
| 3 | +A live kanban to manage projects, built with [tinyhttp](https://github.com/tinyhttp/tinyhttp), [Prisma](https://www.prisma.io/), [Liveblocks](https://liveblocks.io/) and [Nuxt3](https://v3.nuxtjs.org/). |
| 4 | + |
| 5 | +## What's inside? |
| 6 | + |
| 7 | +This repository is a monorepo powered by [Turborepo](https://turborepo.org/). It includes the following packages/apps: |
| 8 | + |
| 9 | +### Applications |
| 10 | + |
| 11 | +- `web`: a [Nuxt3](https://v3.nuxtjs.org/) application |
| 12 | +- `api`: a [tinyhttp](https://github.com/tinyhttp/tinyhttp) API application |
| 13 | + |
| 14 | +### Packages |
| 15 | + |
| 16 | +- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) |
| 17 | +- `tsconfig`: `tsconfig.json`s used throughout the monorepo |
| 18 | + |
| 19 | +### Utilities |
| 20 | + |
| 21 | +- [Tailwind](https://tailwindcss.com/) & [DaisyUI](https://daisyui.com/) for CSS styles and UI components |
| 22 | +- [TypeScript](https://www.typescriptlang.org/) for static type checking |
| 23 | +- [Jest](https://jestjs.io/) for tests |
| 24 | +- [ESLint](https://eslint.org/) for code linting |
| 25 | +- [Commitizen](https://github.com/commitizen/cz-cli) for conventional commit enforcement |
| 26 | + |
| 27 | +## Getting started |
| 28 | + |
| 29 | +### Requirements |
| 30 | +| Name | Version | |
| 31 | +| --------------------------------------------- | ----------- | |
| 32 | +| [Node](https://nodejs.org/en/) | 14.0+ | |
| 33 | +| [Docker](https://www.docker.com/get-started/) | 20.10+ | |
| 34 | + |
| 35 | +### Installation |
| 36 | + |
| 37 | +To get the project started, clone this repository: |
| 38 | +```sh |
| 39 | +# With SSH |
| 40 | +git clone git@github.com:IIM-Creative-Technology/NODEJS-SOCKETIO-IIM-DW1-PROPRE.git |
| 41 | + |
| 42 | +# With HTTP |
| 43 | +git clone https://github.com/IIM-Creative-Technology/NODEJS-SOCKETIO-IIM-DW1-PROPRE.git |
| 44 | +``` |
| 45 | + |
| 46 | +Then install packages: |
| 47 | +```sh |
| 48 | +npm install |
| 49 | +``` |
| 50 | + |
| 51 | +### Development |
| 52 | + |
| 53 | +To run the project for development use: |
| 54 | +```sh |
| 55 | +npm run dev |
| 56 | +``` |
| 57 | +It will automatically run the Nuxt and Adonis apps on your `localhost`. |
| 58 | + |
| 59 | +### Build |
| 60 | + |
| 61 | +To build the project use: |
| 62 | +```sh |
| 63 | +npm run build |
| 64 | +``` |
| 65 | + |
| 66 | +## Tests |
| 67 | +Don't forget to test your code before sending a PR. |
| 68 | + |
| 69 | +To run tests you can run: |
| 70 | +```sh |
| 71 | +npm run test |
| 72 | +``` |
| 73 | + |
| 74 | +## Contributing |
| 75 | +Any help and contribution is welcome, feel free to submit issues and/or contribute to the project. |
| 76 | + |
| 77 | +**Please read through the [contributing guidelines](./.github/CONTRIBUTING.md) for more details.** |
| 78 | + |
| 79 | +## License |
| 80 | +Copyright (c) 2022 Antoine Puech, Florent Vigot, Samir Chalal, Colin Espinas. |
| 81 | + |
| 82 | +**Live Kanban is distributed under the MIT License. [See the license for more details](./LICENSE).** |
0 commit comments