Skip to content

Commit

Permalink
docs(readme): add project structure and prerequisites section
Browse files Browse the repository at this point in the history
  • Loading branch information
WillACosta committed Sep 30, 2024
1 parent b608eca commit 54fff98
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@ This is an Express service written in [TypeScript](https://www.typescriptlang.or
- [Docker](https://docs.docker.com/) Containers for setting up environment.
- [Redis](https://redis.io/) database for storing AI messages.

## Project Structure

```yaml
common: common code and utilities for all modules
di: dependency injection container
modules: application features
module_name:
adapters: class adapters for external resources
dataproviders:
services:

application: application layer for controllers and routes
controllers:
routes:

core: application core logic
entities:
usecases:
utils: class and constant utilities for this module
```
## Prerequisites
Before running the application, make sure you have the following installed:
- NodeJS (v20.12.1)
- PNPM (v9.7.0)
- Docker (v27.2.0)
## Running the application
1. Clone this repository
Expand Down

0 comments on commit 54fff98

Please sign in to comment.