atridad/atri.dad
1
0
Fork 0
Code Projects Releases Packages 1 Activity Actions

README
Some checks failed
Docker Deploy / build-and-push (push) Failing after 48s
Details

Browse source
This commit is contained in:
Atridad Lahiji 2025-01-04 21:25:11 -07:00
parent 62791490f6
commit 71633734ea
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -10,9 +10,12 @@ This is my personal website!
## Requirements:
- Golang 1.23.1
## Instructions:
1. Run ```go get```
2. Duplicate the .env.example file and call it .env
3. Fill out the required .env values
4. Run ```go install github.com/air-verse/air@latest``` to download Air for live reload
5. Run ```air``` to start the dev server (macOS and Linux only)
## Getting Started
1. Clone this repository
2. Copy `.env.example` to `.env`
3. Run `go mod download`
4. Start the server: `go run main.go`
## API Documentation
1. Install swag by running ```go install github.com/swaggo/swag/cmd/swag@latest```
2. Visit `/api/swagger/index.html` after starting the server