Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andre-ols/ibeer
https://github.com/andre-ols/ibeer
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/andre-ols/ibeer
- Owner: andre-ols
- License: apache-2.0
- Created: 2023-12-08T13:27:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-31T00:27:22.000Z (about 1 year ago)
- Last Synced: 2024-11-13T16:50:44.848Z (2 months ago)
- Language: TypeScript
- Size: 17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iBeer - Craft Beer E-commerce
## Overview
**iBeer** is a craft beer e-commerce developed in Node.js, employing advanced practices of Domain Driven Design (DDD), CQRS, and Clean Architecture. The project features two databases, one for write operations (PostgreSQL) and another for read operations (MongoDB). The coordination between these databases is managed by a custom event bus, promoting consistency and integrity in the data.
## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Start Containers](#start-containers)
- [Run Prisma Migrations](#run-prisma-migrations)
- [License](#license)
## Features
- Craft beer commerce
- Implementation of DDD, CQRS, and Clean Architecture
- PostgreSQL for write operations
- MongoDB for read operations
- Data synchronization through a custom event bus
- Containerized with Docker
- Container management with Docker Compose
## Prerequisites
Before starting, make sure you have Docker and Docker Compose installed on your environment.
## Project Structure
**iBeer** is composed of 4 layers:
- **Application**: Responsible for orchestrating business operations.
- **Domain**: Responsible for defining business rules.
- **Infrastructure**: Responsible for implementing integrations with external services.
- **Presentation**: Responsible for implementing user communication interfaces.
Tech Stack:
- Node.js
- TypeScript
- Express
- Prisma
- Mongoose
- PostgreSQL
- MongoDB
- Docker
- Docker Compose
## Getting Started
### Configuration
Create a `.env` file at the root of the project with the necessary configurations, such as environment variables for database connections. Refer to the `.env.example` file for more details.
### Start Containers
```bash
# Start Docker containers
docker compose --env-file .env up -d --build --force-recreate app_dev
```
### Run Prisma Migrations
```bash
# Run Prisma migrations
docker compose --env-file .env exec app_dev yarn prisma migrate reset
```
## License
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.