https://github.com/eltonlazzarin/solid-api
SOLID principles in a REST API with Node.js and TypeScript
https://github.com/eltonlazzarin/solid-api
backend backend-api express-api javascript js-application nodejs nodejs-application nodemailer solid-app solid-principles typescript typescript-nodejs uuidv4
Last synced: about 2 months ago
JSON representation
SOLID principles in a REST API with Node.js and TypeScript
- Host: GitHub
- URL: https://github.com/eltonlazzarin/solid-api
- Owner: eltonlazzarin
- License: mit
- Created: 2020-08-01T02:18:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T05:49:03.000Z (over 1 year ago)
- Last Synced: 2025-10-06T17:46:10.161Z (3 months ago)
- Topics: backend, backend-api, express-api, javascript, js-application, nodejs, nodejs-application, nodemailer, solid-app, solid-principles, typescript, typescript-nodejs, uuidv4
- Language: TypeScript
- Homepage:
- Size: 597 KB
- Stars: 17
- Watchers: 0
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://expressjs.com/)
- [Nodemailer](https://nodemailer.com/about)
- [Uuidv4](https://www.uuidgenerator.net/version4)
- [TypeScript](https://www.typescriptlang.org)
- [VS Code](https://code.visualstudio.com) with [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) and [Prettier RC](https://github.com/prettier/prettier)
## 💻 Getting started
### Requirements
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)
**Clone the project and access the folder**
```bash
$ git clone https://github.com/eltonlazzarin/solid-api.git
$ cd solid-api
```
**Follow the steps below**
```bash
# Install the dependencies
$ yarn i
# Run the web app
$ yarn start
```
## 🤔 How to contribute
**Follow the steps below**
```bash
# 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](https://github.com/eltonlazzarin/solid-api/blob/master/LICENSE) for more information.