https://github.com/benjaminpla/node_api
https://github.com/benjaminpla/node_api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/benjaminpla/node_api
- Owner: benjaminPla
- Created: 2025-04-03T21:29:02.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2025-04-04T10:33:56.000Z (about 2 months ago)
- Last Synced: 2025-04-12T19:17:47.002Z (about 1 month ago)
- Language: TypeScript
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rindus
## overview
this api is built with node.js, express, postgresql, sequelize, and redis. it includes:
- user management with roles (admin, client).
- authentication via jwt and bcrypt for password hashing.
- crud operations
- rate limiting and basic security measures to mitigate bot attacks.
- fully documented and tested using postman.
- dockerized with docker and docker compose, ready to run with postgresql and redis containers.
aimed to showcase my skills with minimal code (limited time!).
## documentation
https://documenter.getpostman.com/view/16085603/2sB2cSiQ4r
## structure
```
.
├── build
│ └── src
│ ├── controllers
│ │ ├── health.js
│ │ └── user
│ │ ├── create.js
│ │ └── get.js
│ ├── helpers
│ │ └── index.js
│ ├── index.js
│ └── routes
│ └── index.js
├── docker-compose.yml
├── Dockerfile
├── package.json
├── package-lock.json
├── README.md
├── src
│ ├── controllers
│ │ ├── authentication
│ │ │ └── authenticate.ts
│ │ ├── health.ts
│ │ ├── post
│ │ │ ├── delete.ts
│ │ │ ├── get.ts
│ │ │ ├── post.ts
│ │ │ └── put.ts
│ │ ├── syncDb.ts
│ │ └── user
│ │ ├── create.ts
│ │ └── get.ts
│ ├── extended.d.ts
│ ├── helpers
│ │ └── index.ts
│ ├── index.ts
│ ├── middlewares
│ │ ├── authenticateToken.ts
│ │ ├── checkAdmin.ts
│ │ ├── checkReq.ts
│ │ └── checkValidId.ts
│ ├── models
│ │ ├── post.ts
│ │ └── user.ts
│ └── routes
│ └── index.ts
└── tsconfig.json
```
## how to run it
### local
1. clone the repo
2. add an _.env_ file
```
[email protected]
ADMIN_PASSWORD=rindus12345
BCRYPT_SALT=10
DB_HOST=localhost
DB_NAME=rindus
DB_PASSWORD=rindus12345
DB_PORT=5432
DB_USERNAME=rindus
ENV='dev'
JWT_EXPIRES_MS=900000
JWT_SECRET=rindus12345
PORT=3000
RATE_LIMITER_MAX=30
RATE_LIMITER_WINDOW_MS=900000
REDIS_EX_S=30
REDIS_URL=redis://localhost:6379
SPEED_LIMITER_DELAY_AFTER=5
SPEED_LIMITER_DELAY_MS=100
SPEED_LIMITER_WINDOW_MS=900000
```
3. you would need a postgres and a redis client running on your pc, you can run:
```
docker run -d \
--name postgres-rindus \
-e POSTGRES_USER=rindus \
-e POSTGRES_PASSWORD=rindus12345 \
-e POSTGRES_DB=rindus \
-p 5432:5432 \
postgres
docker run -d --name redis -p 6379:6379 redis
```
4. run `npm run build && npm run start`
5. sync and populate the db hitting one `syncDb` enpoint, this will create an admin user accoding the _.env_ vars _(this is a bad practice and of course unsecured but I had no more time really)_
6. call the api with any http client following the documentation
### docker
1. run `docker-compose up`
2. sync and populate the db hitting one `syncDb` enpoint, this will create an admin user accoding the _.env_ vars _(this is a bad practice and of course unsecured but I had no more time really)_
3. call the api with any http client following the documentation
## todo
- [ ] saml || oauth
- [x] docker
- [x] roles
- [x] rate limiter + slow down
- [x] middlewares
- [x] cache
- [x] fk
- [ ] soft delete
- [x] jwt
- [x] test
- [ ] refresh token
- [ ] sessionId
- [x] role middleware
- [ ] sequelize pool
- [x] optimistic locking
- [x] documentation
- [ ] modulize router