ignaciochemes / skeleton-express Goto Github PK

This repository is a Backend Javascript & Typescript skeleton with Express, designed for quickly getting started developing an API. Check the Getting Started for full details.

• Typescript 4.7
• Express 4.18
• Yarn
• Supertest
• JEST
• Docker
• Make

Within the Makefile you can handle the entire flow to get everything up & running:

1. Install make on your computer, if you do not already have it.
2. Install the Yarn dependencies: make deps
3. Start the application: make up

As you could see on the Makefile script, you could just avoid those steps and just execute make up, as deps are dependant of it.

Once these steps are finished, you could access to the application navigating into http://localhost:8000/ping.

This skeleton is based on a Clean Architecture approach, so you could find the first basic elements:

You could find here an amazing article explaining this Clean Architecture with Node.js! (credits to @bazaglia).

This folder contains the basic routes to expose in your API. You could add here as much HTTP routes as you need.

This layer is the one in charge of the different use cases of the application. A Use Case it's a workflow of what should it happen to a concrete Domain entity once interacts with the application.

This is the layer which would use any external service and communicate with the world (ie. APIs, databases, etc...)

Any of your domain Entities that models your business logic. These classes should be completely isolated of any external dependency or framework.

If you are having problems or need anything else, please let us know by raising a new issue.

This project is licensed with the MIT license.

Made with ❤️ by Rviewer