Skip to content

Commit

Permalink
docs: Revise README.md to update project structure and enhance contai…
Browse files Browse the repository at this point in the history
…ner setup section
  • Loading branch information
lmcdonough committed Nov 26, 2024
1 parent 9b37055 commit f1e9e57
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,27 +108,9 @@ cargo run -- -l DEBUG -d postgres://refactor:password@localhost:5432/refactor_p
This will start the backend with log level DEBUG and attempt to connect to a Postgres DB server on the same machine with user `refactor` and password `password` on port `5432` and selecting the database named `refactor_platform`.
## Project Directory Structure
`docs` - project documentation including architectural records, DB schema, API docs, etc
`entity_api` - data operations on the various `Entity` models
`entity` - shape of the data models and the relationships to each other
`migration` - relational DB SQL migrations
`scripts` - contains handy developer-related scripts that make working with this codebase more straightforward
`service` - CLI flags, environment variables, config handling and backend daemon setup
`src` - contains a main function that initializes logging and calls all sub-services
`web` - API endpoint definition, routing, handling of request/responses, controllers
---
## Refactor Coaching & Mentoring Platform with Docker & Docker Compose
## Basic Container DB Setup and Management
_This Rust-based backend/web API connects to a PostgreSQL database. It uses Docker and Docker Compose for local development and deployment, including utilities for database management and migrations. You can run PostgreSQL locally (via Docker) or remotely by configuring environment variables._
Expand Down Expand Up @@ -189,4 +171,24 @@ _This Rust-based backend/web API connects to a PostgreSQL database. It uses Dock
docker-compose logs <service>
```
_For additional commands, database utilities, and debugging tips, check the [full README](./runbooks/Container-README.md)._
_For additional commands, database utilities, and debugging tips, check the [Container README](runbooks/Container-README.md)._
---
## Project Directory Structure
`docs` - project documentation including architectural records, DB schema, API docs, etc
`entity_api` - data operations on the various `Entity` models
`entity` - shape of the data models and the relationships to each other
`migration` - relational DB SQL migrations
`scripts` - contains handy developer-related scripts that make working with this codebase more straightforward
`service` - CLI flags, environment variables, config handling and backend daemon setup
`src` - contains a main function that initializes logging and calls all sub-services
`web` - API endpoint definition, routing, handling of request/responses, controllers

0 comments on commit f1e9e57

Please sign in to comment.