Skip to content

leal32b/webapi-nodejs

Repository files navigation

Webapi Nodejs

MIT license Codecov CircleCI Code Climate maintainability Code Climate issues GitHub pull requests GitHub 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:
# 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.