Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cliuno/cliuno-nest-template
Under Cliuno Tool
https://github.com/cliuno/cliuno-nest-template
cliuno nestjs typescript
Last synced: 10 days ago
JSON representation
Under Cliuno Tool
- Host: GitHub
- URL: https://github.com/cliuno/cliuno-nest-template
- Owner: CLIuno
- License: agpl-3.0
- Created: 2022-09-14T14:08:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T12:26:58.000Z (14 days ago)
- Last Synced: 2025-01-01T13:23:07.591Z (14 days ago)
- Topics: cliuno, nestjs, typescript
- Language: TypeScript
- Homepage: https://cliuno.github.io
- Size: 146 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Cliuno Nest.js template
## Installation
if you want to run the project locally make sure you have installed nodejs, pnpm.
to install node js go to [nodejs](https://nodejs.org/en/download/)
to install pnpm run the following command
```bash
npm install -g pnpm
```
if you want to run the project using docker make sure you have installed docker.
to install docker go to [docker](https://docs.docker.com/get-docker/)
to run the project using docker run the following command
```bash
docker compose -d up
```
or pull the image from docker hub
```bash
docker pull iru44/nest-template
```
make sure you pull the database image from docker hub as well
then run the following command
```bash
docker run -p 3000:3000 iru44/nest-template
```
if you want to run the project using kubernetes make sure you have installed minikube.
to install minikube go to [minikube](https://minikube.sigs.k8s.io/docs/start/)
to install kubectl go to [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
## Clone the repository
```bash
git clone https://github.com/CLIuno/CLIuno-Nest-template.git
```
then run the following command
```bash
pnpm install
```
## Usage
to run the project run the following command
```bash
pnpm dev
```
## Features
list of features that already implemented:
| Status | Feature |
| ------------------ | ----------------------------- |
| [ ] | Auth routes |
| [ ] | User routes |
| [ ] | Role routes |
| [ ] | Post routes |
| [ ] | User Role routes |
| [ ] | CI/CD with GitHub Actions |
| :white_check_mark: | Mailer |
| :white_check_mark: | Logging |
| [ ] | Dockerize |
| [ ] | Kubernetes |
| [ ] | Soft delete |
| :white_check_mark: | SQLite database |
| [ ] | Fully documentation |
| :white_check_mark: | Postman collection just basic |
## Premium features
You will get more features if you buy the full version and you can use it for commercial purposes (contact me for more information)
| Status | Feature |
| ------------------ | ---------------------------- |
| :white_check_mark: | Vote routes |
| :white_check_mark: | Comment routes |
| :white_check_mark: | Permission routes |
| :white_check_mark: | Reacion routes |
| :white_check_mark: | Payment routes |
| :white_check_mark: | Notification routes |
| :white_check_mark: | Pagination |
| :white_check_mark: | Redis cache |
| :white_check_mark: | File upload |
| :white_check_mark: | Fully unit test |
| :white_check_mark: | Database Factory |
| :white_check_mark: | Make use of Enums |
| :white_check_mark: | GraphQL (Optional) |
| :white_check_mark: | Postman collection extra |
| :white_check_mark: | Postgres database or MongoDB |
## list of endpoints
### Auth
| Status | Endpoint Description | Method | Path |
| ------------------ | ----------------------- | ------ | -------------------------------- |
| :white_check_mark: | Login | POST | `/api/v1/auth/login` |
| [ ] | Register | POST | `/api/v1/auth/register` |
| [ ] | Logout | POST | `/api/v1/auth/logout` |
| :white_check_mark: | Reset Password | POST | `/api/v1/auth/reset-password` |
| :white_check_mark: | Forgot Password | POST | `/api/v1/auth/forgot-password` |
| :white_check_mark: | Change Password | POST | `/api/v1/auth/change-password` |
| :white_check_mark: | Send Verification Email | POST | `/api/v1/auth/send-verify-email` |
| :white_check_mark: | Verify Email | POST | `/api/v1/auth/verify-email` |
| [ ] | Check Token | POST | `/api/v1/auth/check-token` |
| [ ] | Refresh Token | POST | `/api/v1/auth/refresh-token` |
| :white_check_mark: | Verify OTP | POST | `/api/v1/auth/otp/verify` |
| :white_check_mark: | Disable OTP | POST | `/api/v1/auth/otp/disable` |
| :white_check_mark: | Validate OTP | POST | `/api/v1/auth/otp/validate` |
| :white_check_mark: | Generate OTP | POST | `/api/v1/auth/otp/generate` |
### Users
| Status | Endpoint Description | Method | Path |
| ------ | ----------------------- | ------ | ------------------------------------ |
| [ ] | Get all current user | GET | `/api/v1/users/current` |
| [ ] | Get user by username | GET | `/api/v1/users/username/:username` |
| [ ] | Get all users | GET | `/api/v1/users` |
| [ ] | Get a user by ID | GET | `/api/v1/users/:id` |
| [ ] | Update user by ID | PATCH | `/api/v1/users/:id` |
| [ ] | Delete user by ID | DELETE | `/api/v1/users/:id` |
| [ ] | Get permissions by user | GET | `/api/v1/users/:user_id/permissions` |
| [ ] | Get posts by user | GET | `/api/v1/users/:user_id/posts` |
| [ ] | Get roles by user | GET | `/api/v1/users/:user_id/roles` |
### Roles
| Status | Endpoint Description | Method | Path |
| ------ | ----------------------- | ------ | ------------------------------------ |
| [ ] | Get all roles | GET | `/api/v1/roles` |
| [ ] | Get role by ID | GET | `/api/v1/roles/:id` |
| [ ] | Create a role | POST | `/api/v1/roles` |
| [ ] | Update role by ID | PATCH | `/api/v1/roles/:id` |
| [ ] | Delete role by ID | DELETE | `/api/v1/roles/:id` |
| [ ] | Get permissions by role | GET | `/api/v1/roles/:role_id/permissions` |
| [ ] | Get users by role | GET | `/api/v1/roles/:role_id/users` |
### Posts
| Status | Endpoint Description | Method | Path |
| ------ | -------------------------- | ------ | ----------------------------- |
| [ ] | Get all current user posts | GET | `/api/v1/posts/current-user` |
| [ ] | Get all posts | GET | `/api/v1/posts` |
| [ ] | Get post by ID | GET | `/api/v1/posts/:id` |
| [ ] | Create a post | POST | `/api/v1/posts` |
| [ ] | Update post by ID | PATCH | `/api/v1/posts/:id` |
| [ ] | Delete post by ID | DELETE | `/api/v1/posts/:id` |
| [ ] | Get users by post | GET | `/api/v1/posts/:post_id/user` |