Skip to content

Commit 477362a

Browse files
committed
docs: Fixed linting errors in README and Container-README
1 parent 157c4c2 commit 477362a

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[![Build & Tests (backend)](https://github.com/Jim-Hodapp-Coaching/refactor-platform-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Jim-Hodapp-Coaching/refactor-platform-rs/actions/workflows/ci.yml)
22

33
# Refactor Coaching & Mentoring Platform
4-
### Backend
4+
5+
## Backend
56

67
## Intro
78

@@ -86,6 +87,7 @@ DATABASE_URL=postgres://refactor:password@localhost:5432/refactor_platform sea-o
8687
```
8788
8889
### Generate a new Entity from Database
90+
8991
Note that to generate a new Entity using the CLI you must ignore all other tables using the `--ignore-tables` option. You must add the option for _each_ table you are ignoring.
9092
9193
```bash

docs/runbooks/Container-README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
*This project is a Rust-based backend/web API that connects to a PostgreSQL database. It uses Docker and Docker Compose for easy local development and deployment, and includes utilities for database management, migrations, and more. You can choose to run PostgreSQL either locally (via Docker) or remotely by configuring the environment variables.*
44

5-
## **Prerequisites**
5+
## Prerequisites
66

77
Before you begin, ensure you have the following installed:
88

99
- [Docker](https://www.docker.com/products/docker-desktop) (version 20+)
1010
- [Docker Compose](https://docs.docker.com/compose/install/) (version 1.29+)
1111

12-
## **Project Setup**
12+
## Project Setup
1313

1414
1. **Clone the repository**:
1515

@@ -29,6 +29,7 @@ Before you begin, ensure you have the following installed:
2929
Create a `.env.remote-db` file and set `POSTGRES_HOST` to the external IP or hostname of the remote PostgreSQL instance.
3030

3131
Example `.env.local` for local development:
32+
3233
```env
3334
POSTGRES_USER=refactor
3435
POSTGRES_PASSWORD=password
@@ -42,6 +43,7 @@ Before you begin, ensure you have the following installed:
4243
```
4344

4445
Example `.env.remote-db` for remote PostgreSQL:
46+
4547
```env
4648
POSTGRES_USER=remote_user
4749
POSTGRES_PASSWORD=remote_password
@@ -84,7 +86,7 @@ Before you begin, ensure you have the following installed:
8486
- postgres
8587
```
8688
87-
## **Building and Running the Application**
89+
## Building and Running the Application
8890
8991
### **Step 1: Build the Docker images**
9092
@@ -118,7 +120,7 @@ docker-compose --env-file .env.remote-db up
118120

119121
The Rust web API should now be running on `http://localhost:8080` and PostgreSQL should be available on port `5432` (or remotely if using the `.env.remote-db` setup).
120122

121-
## **Using the Database Utilities**
123+
## Using the Database Utilities
122124

123125
### **Rebuild the database**
124126

@@ -150,7 +152,7 @@ docker-compose run -v $(pwd)/sql:/app/sql -v $(pwd)/schema.dbml:/app/schema.dbml
150152

151153
This will output the generated SQL file in the `sql` directory.
152154

153-
## **Stopping the Containers**
155+
## Stopping the Containers
154156

155157
To stop the containers, you can use the following command:
156158

@@ -164,7 +166,7 @@ If you want to remove all the containers, networks, and volumes, including the P
164166
docker-compose down -v
165167
```
166168

167-
## **Troubleshooting and Gotchas**
169+
## Troubleshooting and Gotchas
168170

169171
### **1. Cannot connect to PostgreSQL**
170172

@@ -240,7 +242,7 @@ docker-compose down -v
240242
241243
If the data is still being wiped, make sure you are not running `docker-compose down -v` unless you want to remove the database volume.
242244
243-
## **Tips for Development**
245+
## Tips for Development
244246
245247
- You can bring up the containers in detached mode by running:
246248

0 commit comments

Comments
 (0)