https://github.com/williamkoller/my-readings

API of my readings, developed in Nest.js, MongoDB, Nginx and Dockerized
https://github.com/williamkoller/my-readings

api api-rest authentication aws codeql codequality design-patterns docker mongodb nestjs nginx nginx-docker nginx-proxy s3 server-side solid solid-principles swagger swagger-express typescript

Last synced: 8 days ago
JSON representation

API of my readings, developed in Nest.js, MongoDB, Nginx and Dockerized

• Host: GitHub
• URL: https://github.com/williamkoller/my-readings
• Owner: williamkoller
• Created: 2022-03-29T00:05:32.000Z (about 3 years ago)
• Default Branch: develop
• Last Pushed: 2023-04-12T18:59:21.000Z (about 2 years ago)
• Last Synced: 2025-03-30T08:02:20.297Z (about 1 month ago)
• Topics: api, api-rest, authentication, aws, codeql, codequality, design-patterns, docker, mongodb, nestjs, nginx, nginx-docker, nginx-proxy, s3, server-side, solid, solid-principles, swagger, swagger-express, typescript
• Language: TypeScript
• Homepage: https://api-my-readings.herokuapp.com/api/docs/
• Size: 1.7 MB
• Stars: 30
• Watchers: 3
• Forks: 8
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/aab1812bcc984ff9aebc4fd9d0160669)](https://www.codacy.com/gh/williamkoller/my-readings/dashboard?utm_source=github.com&utm_medium=referral&utm_content=williamkoller/my-readings&utm_campaign=Badge_Grade)

[![CodeQL](https://github.com/williamkoller/my-readings/workflows/CodeQL/badge.svg)](https://github.com/williamkoller/my-readings/actions?query=workflow%3ACodeQL)

[![Production](https://github.com/williamkoller/my-readings/actions/workflows/heroku.yml/badge.svg)](https://github.com/williamkoller/my-readings/actions/workflows/heroku.yml)

![GitHub top language](https://img.shields.io/github/languages/top/williamkoller/my-readings)

![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/williamkoller/my-readings)

![GitHub issues](https://img.shields.io/github/issues/williamkoller/my-readings)

![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/williamkoller/my-readings)



## My Readings

step by step for configuration with docker

**OBS**: _required docker and docker-compose_

- `cp -r .env.sample .env`

- `docker-compose up`

Next step:

- [x] add nginx for proxy reverse

- [x] add authentication with JWT

- [x] add routes authenticated

- [x] add makefile for automatization commands

- [x] add AWS S3 for Upload files

- [x] add Redis for cache some endpoints

- [x] add cron job

- [x] add queue with bull

- [x] add rate limiting

- [x] add logging

- [x] add GraphQL

- [x] add deploy with heroku

Made with 🖤 by [williamkoller](https://github.com/williamkoller) :wave: