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:

• Node.js
• Sendpulse

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

🚀 Technologies

This project was built using the following technologies:

• express
• nodemailer
• uuid

💻 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": "doe@example.com",
	"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.