🚧 Clean Server - In Development 🚀 🚧

About • How to execute • Technologies • How to contribute • Author • License

💻 About the project

Template Clean Server - is a way to speed up the process of creating a new node backend project, this template was developed considering good programming practices, as well as clean architecture concepts.

---

🚀 How to execute the project

This template was developed with Typescript, so make sure it is usual for your context before installing.

Pre-requisites

Before you start, you will need to have the following tools installed on your machine Git, Node.js. Moreover it is good to have a dynamic editor to work with the code as VSCode

🎲 Running the server

# Clone this repository
$ git clone git@github.com:Leandro2585/template-node-clean.git

# Go to project folder
$ cd clean-server

# Install the dependencies
$ npm install

# Execute the application in development mode
$ npm run start

# The server started at port:3333 - access http://localhost:3333

---

🛠 Technologies

Clean Server (NodeJS + TypeScript)

• Express

See the file package.json

Utilities

• Editor: Visual Studio Code
• Server Test: Insomnia

---

💪 How to contribute to the project

1. Make a fork of project.
2. Create a new branch with your changes: git checkout -b my-feature
3. Save changes and create a commit message telling what you did: git commit -m "feature: My new feature"
4. Submit your changes: git push origin my-feature

If you have any questions, check out this guide on how to contribute to GitHub

---

Author

_{Leandro Real} 🚀

---

📝 License

This project is under license GPL.

Done with ❤️ by Leandro Real 👋🏽 Contact!

---

README Versions

Portuguese 🇧🇷 | English 🇺🇸