Skip to content
This repository was archived by the owner on Dec 12, 2022. It is now read-only.

Commit c5eac13

Browse files
committed
chore(init): initial project setup
0 parents  commit c5eac13

28 files changed

Lines changed: 21426 additions & 0 deletions

.eslintrc.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
root: true,
3+
// This tells ESLint to load the config from the package `eslint-config-custom`
4+
extends: ['custom'],
5+
};

.github/CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# How to contribute
2+
3+
Any help and contribution is welcome, feel free to submit issues and/or contribute to the project.
4+
5+
## Prerequisites
6+
7+
- Fork the repository and clone your fork.
8+
- Create a branch and name it explicitly, like so: `feature/name-of-the-feature`
9+
- Install dependencies: `npm install`.
10+
11+
## Development workflow
12+
13+
In most cases you'll start from `dev` branch and merge back to `dev` branch.
14+
Exceptions can be made for hotfixes but need to stay exceptionals.
15+
16+
To build your changes run:
17+
18+
```bash
19+
npm run build
20+
```
21+
22+
Or build in development mode:
23+
```bash
24+
npm run dev
25+
```
26+
27+
Run linters:
28+
29+
```bash
30+
npm run lint
31+
```
32+
33+
**Please update npm lock file (`package-lock.json`) if you add or update dependencies.**
34+
35+
## Other notes
36+
37+
- If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
38+
- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), like so: `feat(scope): topic` (this repository is [commitizen friendly](https://github.com/commitizen/cz-cli), we recommend you use it to avoid any trouble).
39+
- Don’t commit generated files.
40+
- Don’t change version number and changelog.
41+
42+
## Need help?
43+
44+
If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with `WIP` (Work In Progress) in its title and ask questions in the pull request description.

.gitignore

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
node_modules
5+
.pnp
6+
.pnp.js
7+
8+
# testing
9+
coverage
10+
11+
# next.js
12+
.next/
13+
out/
14+
build
15+
16+
# misc
17+
.DS_Store
18+
*.pem
19+
20+
# debug
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
.pnpm-debug.log*
25+
26+
# local env files
27+
.env
28+
.env.local
29+
.env.development.local
30+
.env.test.local
31+
.env.production.local
32+
33+
# turbo
34+
.turbo

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Antoine Puech, Florent Vigot, Samir Chalal, Colin Espinas
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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).**

apps/api/.eslintrc.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
root: true,
3+
// This tells ESLint to load the config from the package `eslint-config-custom`
4+
extends: ['custom'],
5+
};

apps/api/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
# Keep environment variables out of version control
3+
.env

apps/api/index.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import { App } from '@tinyhttp/app';
2+
import { logger } from '@tinyhttp/logger';
3+
4+
const app = new App();
5+
6+
app
7+
.use(logger())
8+
.get('/', (_, res) => res.send('<h1>Hello World</h1>'))
9+
.get('/page/:page/', (req, res) => {
10+
res.status(200).send(`
11+
<h1>Some cool page</h1>
12+
<h2>URL</h2>
13+
${req.url}
14+
<h2>Params</h2>
15+
${JSON.stringify(req.params, null, 2)}
16+
`);
17+
}).listen(3001);

apps/api/package.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "api",
3+
"private": true,
4+
"version": "1.0.0",
5+
"main": "index.js",
6+
"type": "module",
7+
"scripts": {
8+
"dev": "nodemon --watch './**/*.ts' --exec 'node --loader ts-node/esm' ./index.ts"
9+
},
10+
"devDependencies": {
11+
"@types/node": "^17.0.33",
12+
"prisma": "^3.14.0",
13+
"ts-node": "^10.7.0",
14+
"tsconfig": "*",
15+
"typescript": "^4.6.4"
16+
},
17+
"dependencies": {
18+
"@prisma/client": "^3.14.0",
19+
"@tinyhttp/app": "^2.0.20",
20+
"@tinyhttp/logger": "^1.3.0"
21+
}
22+
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
-- CreateTable
2+
CREATE TABLE "User" (
3+
"id" SERIAL NOT NULL,
4+
"email" TEXT NOT NULL,
5+
"name" TEXT,
6+
"password" TEXT NOT NULL,
7+
8+
CONSTRAINT "User_pkey" PRIMARY KEY ("id")
9+
);
10+
11+
-- CreateIndex
12+
CREATE UNIQUE INDEX "User_email_key" ON "User"("email");

0 commit comments

Comments
 (0)