Git Product home page Git Product logo

rm-clean-ts-api's Introduction

Survey - Clean TS API

CircleCI

Docker NodeJS Typescript JavaScript MongoDB

πŸ’¬ About

This project was developed following Udemy's "NodeJs, Typescript, TDD, DDD, Clean Architecture e SOLID" class.

πŸ› Architecture

πŸ”‘ Login

APIs built during training

  1. SignUp
  2. Login
  3. Add survey
  4. List surveys
  5. Answer survey
  6. Survey result

Principles

  • Single Responsibility Principle (SRP)
  • Open Closed Principle (OCP)
  • Liskov Substitution Principle (LSP)
  • Interface Segregation Principle (ISP)
  • Dependency Inversion Principle (DIP)
  • Separation of Concerns (SOC)
  • Don't Repeat Yourself (DRY)
  • You Aren't Gonna Need It (YAGNI)
  • Keep It Simple, Silly (KISS)
  • Composition Over Inheritance
  • Small Commits

Design Patterns

  • Factory
  • Adapter
  • Composite
  • Decorator
  • Proxy
  • Dependency Injection
  • Abstract Server
  • Composition Root
  • Builder
  • Singleton

Methodologies & Designs

  • TDD
  • Clean Architecture
  • DDD
  • Conventional Commits
  • GitFlow
  • Modular Design
  • Dependency Diagrams
  • Use Cases
  • Continuous Integration
  • Continuous Delivery
  • Continuous Deployment

Features - Node

  • API Docs with Swagger
  • API Rest with Express
  • GraphQL with Apollo Server
  • Log de Erro
  • Security(Hashing, Encryption & Encoding)
  • CORS
  • Middlewares
  • Access leves in routes (Admin, User & Anon)
  • Heroku Deploy
  • Static files

Features - GraphQL

  • Types
  • Queries
  • Mutations
  • Resolvers
  • Directives
  • Scalars
  • Plugins

Features - Git

  • Alias
  • Custom Log
  • Branch
  • Reset
  • Amend
  • Tag
  • Stash
  • Rebase
  • Merge

Features do Typescript

  • Advanced POO
  • Interface
  • TypeAlias
  • Namespace
  • Utility Types
  • Paths Modularization
  • Configs
  • Build
  • Deploy
  • Breakpoints

Features do GraphQL

  • Resolvers
  • Type Definitions
  • Directives
  • Scalars
  • Plugins
  • Error Handling

Features - Tests

  • Unit tests
  • Integration tests (API Rest & GraphQL)
  • Coverage
  • Test Doubles
  • Mocks
  • Stubs
  • Spies
  • Fakes

Features - MongoDb

  • Connect e Reconnect
  • Collections
  • InsertOne e InserMany
  • Find, FindOne e FindOneAndUpdate
  • DeleteMany
  • UpdateOne
  • Aggregation (Match, Group, Unwind, Lookup, AddFields, Project, Sort)
  • ObjectId
  • Upsert e ReturnOriginal
  • Push, Divide, Multiply, ArrayElemAt, Cond, Sum
  • Filter, Map, Reduce, MergeObjects, ConcatArrays

πŸ’» Technologies

πŸ“œ Requirements

πŸ’Ώ Installation

git clone [email protected]:filipe1309/rm-clean-ts-api.git
cd rm-clean-ts-api

πŸƒ Running

Up the container with tha API & DB:

make up

Stop with make down

See Makefile for more information

Access http://localhost:5050/api

Access docs http://localhost:5050/api-docs

Endpoints

Access api.http here.

βœ… Tests

make test
make test-verbose
make test-unit
make test-integration
make test-staged
make test-ci
make test-clear

License

MIT

About Me


Done withΒ Β :heart:Β Β by Filipe Leuch Bonfim πŸ––


@ Generated with ShubcoGen Templateβ„’ v0.3.11
❓ Docs

rm-clean-ts-api's People

Contributors

filipe1309 avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  avatar  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.