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

Related tags

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

Codacy Badge CodeQL GitHub top language GitHub package.json version (subfolder of monorepo) GitHub issues Snyk Vulnerabilities for GitHub Repo

My Readings

step by step for configuration with docker

OBS: required docker and docker-compose

  • cp -r .env.sample .env

  • docker-compose up

example what the body has to be to add a new book

  • method: POST
  • statusCode: 201
  • endpoint: http://localhost:3001/api/books

body

{
  "name": "De zero a Um",
  "description": "O que aprender sobre empreendedorismo com o vale do silicio",
  "author": "Peter Thiel e Blake Masters",
  "status": "pending",
  "url": "https://url-fake/img.png"
}

response

{
  "id": "624e2085a25ae260f044098a",
  "name": "De zero a Um",
  "description": "O que aprender sobre empreendedorismo com o vale do silicio",
  "author": "Peter Thiel e Blake Masters",
  "status": "pending",
  "url": "https://url-fake/img.png",
  "createdAt": "2022-04-06T23:21:41.216Z",
  "updatedAt": "2022-04-06T23:21:41.216Z"
}

example of how the response of already registered books has to be

  • method: GET
  • statusCode: 200
  • endpoint: http://localhost:3001/api/books

response

[
  {
    "id": "624e2085a25ae260f044098a",
    "name": "De zero a Um",
    "description": "O que aprender sobre empreendedorismo com o vale do silicio",
    "author": "Peter Thiel e Blake Masters",
    "status": "pending",
    "url": "https://url-fake/img.png",
    "createdAt": "2022-04-06T23:21:41.216Z",
    "updatedAt": "2022-04-06T23:21:41.216Z"
  }
]

example of how the answer of the books has to be, looking for the _id

  • method: GET
  • statusCode: 200
  • endpoint: http://localhost:3001/api/books/:_id

response

{
  "id": "624e2085a25ae260f044098a",
  "name": "De zero a Um",
  "description": "O que aprender sobre empreendedorismo com o vale do silicio",
  "author": "Peter Thiel e Blake Masters",
  "status": "pending",
  "url": "https://url-fake/img.png",
  "createdAt": "2022-04-06T23:21:41.216Z",
  "updatedAt": "2022-04-06T23:21:41.216Z"
}

example of what the response has to be when updating a book by _id

  • method: PUT
  • statusCode: 200
  • endpoint: http://localhost:3001/api/books/:_id

body

{
  "url": "https://url-fake.com/img.png"
}

response

{
  "_id": "624e2085a25ae260f044098a",
  "name": "De zero a Um",
  "description": "O que aprender sobre empreendedorismo com o vale do silicio",
  "author": "Peter Thiel e Blake Masters",
  "status": "pending",
  "url": "https://url-fake.com/img.png",
  "createdAt": "2022-04-06T23:21:41.216Z",
  "updatedAt": "2022-04-06T23:21:41.216Z",
  "__v": 0
}

example of what the response should be when deleting a book

  • method: DELETE
  • statusCode: 200
  • endpoint: http://localhost:3001/api/books/:_id

response

{
  "message": "Book deleted with successfully"
}

Next step:

  • add nginx for proxy reverse
  • add authentication with JWT
  • add routes authenticated
  • add makefile for automatization commands
  • add AWS S3 for Upload files
  • add Redis for cache some endpoints
  • add cron job
  • add queue with bull
  • add rate limiting
  • add logging
  • add logs module
  • add GraphQL
  • add file procfile for deploy heroku

Made with 🖤 by williamkoller 👋

Comments
Releases(v2.0.2)
Owner
William Koller
William Koller
GitHub
The NEST Prize Bot is a tool for the activity of the NEST community.

NEST Prize Bot The NEST Prize Bot is a tool developed by our team for the activity of the NEST community. It can record the receipt of Prize and expor

NEST Protocol 403 Dec 20, 2022
A dockerized uptime monitoring RESTful API server that allows authenticated users to monitor URLs

A dockerized uptime monitoring RESTful API server that allows authenticated users to monitor URLs, and get detailed uptime reports about their availability, average response time, and total uptime/downtime.

Anas Hamed 2 Oct 7, 2022
Nest accessory developed with HAP-NodeJS to allow devices into HomeKit

Nest_accfactory This is a HAP-NodeJS accessory I have developed to allow Nest devices to be used with HomeKit including having support for HomeKit Sec

markh 9 Oct 9, 2022
Atlan is a CLI that helps you to manage local dockerized infrastructure without any needed knowledge on Docker and Docker Compose.

Atlan CLI Atlan is a CLI that helps you to manage local dockerized infrastructure without any needed knowledge on Docker and Docker Compose. What is A

Myastro 10 Aug 17, 2022
A dockerized express mysql starter using typescript which iclude user management

A dockerized express mysql starter using typescript which iclude user management

Nimatullah Razmjo 2 Jan 26, 2022
📝 Algorithms and data structures implemented in JavaScript with explanations and links to further readings

?? Algorithms and data structures implemented in JavaScript with explanations and links to further readings

Oleksii Trekhleb 157.8k Dec 29, 2022
My-portfolio - Built with Namecheap, Digital Ocean, Nginx, PM2, SSL, NextJs, Tailwind 3, Graphql, NexusJS, Prisma, Postgres, Passion and Love

Current Implementation technologies Nextjs with Typescript. Static pages/ Server side rendering. Easy peasy state management (Might not need it with i

Samrood Ali 1 Jan 10, 2022
Automated packaging of Debian-flavored NGINX with PageSpeed modules. Written in Bash and GitHub Workers. APT Repository hosted on Dokku.

NGINX + Google PageSpeed Configuring NGINX to build correctly is a pain. Not because of anything wrong with it, but rather because of how slim the sta

Slava Knyazev 21 Oct 14, 2022
API Bate Papo UOL - A backend application developed using NodeJS and mongoDB

BatePapoUOL BackEnd My first backend project! Building an API to the most used brazillian chat app ages ago - Bate Papo UOL! Table of Contents Overvie

Lucas Azzolini Vieira 8 Apr 13, 2022
Script written in JavaScript (Node) that uploads CGM readings from LibreLink Up to Nightscout

Nightscout LibreLink Up Uploader/Sidecar Simple Script written in JavaScript (Node) that uploads CGM readings from LibreLink Up to Nightscout. The upl

Timo Schlüter 87 Jan 7, 2023
A new way to share your readings with friends. Hope you like it!

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

Gardenia Georgia 4 Sep 9, 2022
🍎 A simple application which enables you to sync readings from your Withings scale to a Notion page.

weight-logger weight-logger is a simple application which enables you to sync readings from your Withings scale to a Notion page. Preview Installation

Juri Adams 2 Jan 14, 2022
A secure MERN Stack boilerplate ready for Production that uses Docker & Nginx.

A production ready & secure boilerplate for the MERN Stack that uses Docker & Nginx. Focus on the product and not the setup. You can directly start wo

Karan Jagtiani 34 Dec 23, 2022
A developer directory built on Next.js and MongoDB Atlas, deployed on Vercel with the Vercel + MongoDB integration.

MongoDB Starter – Developer Directory A developer directory built on Next.js and MongoDB Atlas, deployed on Vercel with the Vercel + MongoDB integrati

Vercel 246 Dec 20, 2022
Mongo Strict is a TypeScript based smart MongoDB ORM, It makes the usage of MongoDB safer, easier and faster with a better performance...

mongo-strict mongo-strict is compatible with mongo >= 5 Mongo Strict is a TypeScript-based smart MongoDB ORM, It makes the usage of MongoDB safer, eas

Mohamed Kamel 4 Sep 22, 2022
A Nest.js API for a restaurant storage management system.

Restaurant Storage Management System Description A Nest.js API for a restaurant storage management system. Installation $ yarn install Database Seeder

Shayan Shojaei 3 Sep 12, 2022
Hi, this is the meditation app made with React Native (for the frontend) and Nest.js (for the backend). It is a simple app that allows you to meditate for a certain amount of time. It is a work in progress, so there are some bugs and some features that are not implemented yet. The app is still in development, so please be patient. You are welcome to contribute to the project.

Meditation App Hi, this is the meditation app made with React Native (for the frontend) and Nest.js (for the backend). It is a simple app that allows

Jay 45 Jan 4, 2023
Nest multiple blocks inside lists of any kind of list (ordered, unordered, no marker, etc), or do away with list markers and use it like a repeater!

Nest multiple blocks inside lists of any kind of list (ordered, unordered, no marker, etc), or do away with list markers and use it like a repeater!

Rani 15 Dec 26, 2022
OpenAPI (Swagger) module for Nest framework (node.js) :earth_americas:

A progressive Node.js framework for building efficient and scalable server-side applications. Description OpenAPI (Swagger) module for Nest. Installat

nestjs 1.3k Jan 6, 2023