https://github.com/leal32b/webapi-nodejs

Webapi Nodejs Template
https://github.com/leal32b/webapi-nodejs

clean-architecture ddd domain-driven-design nodejs tdd template test-driven-development typescript vitest

Last synced: 15 days ago
JSON representation

Webapi Nodejs Template

• Host: GitHub
• URL: https://github.com/leal32b/webapi-nodejs
• Owner: leal32b
• License: mit
• Created: 2021-09-16T22:19:44.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T10:11:03.000Z (over 1 year ago)
• Last Synced: 2024-04-20T15:10:43.418Z (about 1 year ago)
• Topics: clean-architecture, ddd, domain-driven-design, nodejs, tdd, template, test-driven-development, typescript, vitest
• Language: TypeScript
• Homepage:
• Size: 2.04 MB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Webapi Nodejs

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![Codecov](https://img.shields.io/codecov/c/github/leal32b/webapi-nodejs?logo=codecov&logoColor=white)](https://app.codecov.io/gh/leal32b/webapi-nodejs)

[![CircleCI](https://img.shields.io/circleci/build/github/leal32b/webapi-nodejs/main?logo=circleci)](https://app.circleci.com/pipelines/github/leal32b/webapi-nodejs)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/leal32b/webapi-nodejs?logo=code-climate)](https://codeclimate.com/github/leal32b/webapi-nodejs/maintainability)

[![Code Climate issues](https://img.shields.io/codeclimate/issues/leal32b/webapi-nodejs?logo=codeclimate)](https://codeclimate.com/github/leal32b/webapi-nodejs/issues)

[![GitHub pull requests](https://img.shields.io/github/issues-pr/leal32b/webapi-nodejs?logo=github)](https://github.com/leal32b/webapi-nodejs/pulls)

[![GitHub issues](https://img.shields.io/github/issues/leal32b/webapi-nodejs?logo=github)](https://github.com/leal32b/webapi-nodejs/issues)

This project aims to serve as a template for the creation of new Web APIs. Applying concepts of TDD (Test-Driven Development), DDD (Domain-Driven Design) and Clean Architecture, it comes with pre-built: user and profile management, events handling and the option to use SQL or noSQL databases.

## Getting Started

- Create a copy of `.env.development` and rename it to `.env`

- Run the following commands:

```bash

# Install dependencies:

npm install

# Build project:

npm run build

# Start containers (make sure docker is running on your machine):

npm run docker:up

# Run migrations:

npm run migration:run

# Endpoint will be listening at http://localhost:3000/api

```

## Technologies & Tools















































## License

Licensed under the [MIT](LICENSE) license.