README.md

SOLID principles in a REST API with Node.js and TypeScript

About The Project   |    Technologies   |    Getting Started   |    How To Contribute   |    License

👨🏻‍💻 About the project

SOLID Principles is a coding standard that all developers should have a clear concept for developing software properly to avoid a bad design. It was promoted by Robert C Martin and is used across the object-oriented design spectrum. When applied properly it makes your code more extendable, logical, and easier to read.

So, I decided to study and I created a simple SOLID API with Node.js and TypeScript.

This project consists of sending welcome emails after creating a registration in the application via Insomnia.

🚀 Technologies

Main technologies that I used to develop this frontend app

• Express
• Nodemailer
• Uuidv4
• TypeScript
• VS Code with EditorConfig and Prettier RC

💻 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/solid-api.git

$ cd solid-api

Follow the steps below

# Install the dependencies
$ yarn i

# Run the web app
$ yarn start

🤔 How to contribute

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/solid-api.git

$ cd solid-api

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 License

This project is under the MIT license. See the LICENSE for more information.

Learning Pull Requests

This section was added as part of learning how to create pull requests.

• Added by: [Your Name]
• Date: [Today's Date]
• Purpose: Learning Git and GitHub workflow