Git Product home page Git Product logo

nestjs-node-challenge's Introduction

REST API Ecommerce NestJS challenge

NestJS challenge of a selective process to be made within a week. The system is divided into User, Client, Product, Order, Order Items, and Selling Reports entities containing different types of relationships. The main features are Authentication, Permission, and Clients and Products Management. The API is connected with AWS S3 and deployed on EC2, based on a Clean architecture and documented on Swagger.

Table of Contents


Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to have Docker, Docker Compose, and Node version 20.11.1 installed in your machine.

  1. Follow the official documentation to install the Node: https://nodejs.org/en/download

Installing and Running

To run the project for the first time you must follow these steps:

  1. Clone the GitHub repository:
git clone https://github.com/Giovaniavs/nestjs-node-challenge.git
  1. Create a .env file with these credential availeble at: https://github.com/brocoders/nestjs-boilerplate/blob/main/env-example-relational

  2. In you .env:

  Change DATABASE_HOST=postgres to DATABASE_HOST=localhost
  Change MAIL_HOST=maildev to MAIL_HOST=localhost
  1. Open the terminal and run:
  docker compose up -d postgres adminer maildev
  npm install
  npm run migration:run
  npm run start:dev
  1. Open http://localhost:3000
  2. Deployed version http://ec2-3-80-202-206.compute-1.amazonaws.com:3000/

Features

  • Authentication
  • Permission/Protected Routes
  • Email confirmation
  • Users CRUD
  • Clients CRUD
  • Products CRUD
  • Swagger documentation
  • S3 Bucket integration
  • EC2 Server deployed
  • Clean Architecture
  • Orders Management
  • Custom Reports
  • App Crash Monitoring

Developed by Giovani Albuquerque

nestjs-node-challenge's People

Contributors

giovaniavs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.