rideaware/rideaware-api
1
0
Fork 0
Code Issues 15 Pull requests Projects 1 Releases Packages Wiki Activity Actions

docs: formatting issues

Browse source
This commit is contained in:
Cipher Vance 2025-09-18 21:03:38 -05:00
parent 56c8d3a786
commit 7620a938f5
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -29,7 +29,7 @@ Ensure you have the following installed on your system:
2. **Install Go Dependencies** 2. **Install Go Dependencies**
```bash ```bash
go mod tidy go mod tidy
``` ```
@ -51,8 +51,10 @@ PG_USER=your_postgres_user
PG_PASSWORD=your_postgres_password PG_PASSWORD=your_postgres_password
# Application Configuration # Application Configuration
# SECRET_KEY should be a random 32+ byte string; rotate on compromise.
SECRET_KEY=your_secret_key_for_sessions SECRET_KEY=your_secret_key_for_sessions
PORT=8080 PORT=8080
PG_SSLMODE=require # use "disable" only for local dev
# Email Configuration (Optional) # Email Configuration (Optional)
SMTP_SERVER=your_smtp_server SMTP_SERVER=your_smtp_server
@ -69,7 +71,7 @@ SMTP_PASSWORD=your_email_password
go run main.go go run main.go
``` ```
The application will be available at http://localhost:8080. The application will be available at [http://localhost:8080](http://localhost:8080).
#### Production Mode #### Production Mode
@ -100,7 +102,7 @@ docker build -t rideaware-api .
docker run -d -p 8080:8080 --env-file .env rideaware-api docker run -d -p 8080:8080 --env-file .env rideaware-api
``` ```
The application will be available at http://localhost:8080. The application will be available at [http://localhost:8080](http://localhost:8080).
### Example Dockerfile ### Example Dockerfile