Giter Club home page Giter Club logo

solid-api's Introduction

Discord logo

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

GitHub top language GitHub language count GitHub last commit GitHub issues GitHub

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

👨🏻‍💻 About the project

Insomnia

Mailtrap

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

💻 Getting started

Requirements

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.

solid-api's People

Contributors

eltonlazzarin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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.