Git Product home page Git Product logo

amalanche's Introduction

AMAlanche

Get Started

To launch backend server install node package using:

npm install

After package installations, you can start nodemon launching:

npm run dev

Or with docker:

npm run docker:dev

Project Structure

  • app : folder for frontend application;
  • src : folder for backend application;
    • interfaces: contains all interfaces to take full advantage of typescript;
    • loaders: this folder contains all script to initialize server, executed once at server startup, like dependency container and express initialization;
    • middleware: this folder group all middleware;
    • models: folder for database entity;
    • routes: api entry point;
    • services: folder with all Business logic;
    • types: folder with all types;
    • utils: utils folder;

Dependency Injection

This project is predispose to use Dependency Injection. See typedi documentation.

Request validation

To validate request has been introduced celebrate middleware.

API Example

It has already been implemented an example test api

Endpoint

POST - http://localhost:3000/api/users/test/


Request Body

{
  "id": "xyz"
}

Response Body

{
    "id": "xyz",
    "name": "test",
    "email": "[email protected]",
    "creationDate": "2022-11-19T08:55:41.849Z"
}

amalanche's People

Contributors

papo1011 avatar datge avatar matteasu avatar bozzelliandrea avatar andrebonda avatar simonegollo 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.