Giter VIP home page Giter VIP logo

solid-api-typescript's Introduction


A full SOLID TypeScript Node.js API

A quick and useful TypeScript application using solid programming orientation.

SOLID are five design principles of OOP to make software development more understandable, flexible and maintainable.

This project was built for learning proposes alongside with @Cu4rRy.

๐Ÿ“‹ Requirements

You may use Windows, macOS, or Linux as your development operating system and the following tools:

In order to be able to send SMS, this project uses a sms provider

๐Ÿš€ Technologies

This project was built using the following technologies:

๐Ÿ’ป Installation

To clone this project to your environment, simply execute the following command:

Remind: You must be on your project root directory

git clone https://github.com/kfbfarley/solid-api-typescript.git .
npm install

๐Ÿ”Ž Usage

npm run start

Here is an example of the POST body request you have to send to http://localhost:3000/user

{
	"first_name": "Jonh",
	"last_name": "Doe",
	"age": "20",
	"email": "[email protected]",
	"phone": "+351999999999",
	"password": "doe1999"
}

After that your response status code will be 201. Email & SMS will be sent to the registered user

๐Ÿ‘ Contributing

Contributions are what make this platform an amazing place to learn, inspire, and create. Please feel free to visit the open issues section to propose or create a related issue.

๐Ÿ“„ Licensing

This repository is MIT licensed, as found in the LICENSE file.

solid-api-typescript has no documentation, just this repo.

solid-api-typescript's People

Contributors

kfbfarley avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

cu4rry

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.