Skip to content

Commit

Permalink
create README
Browse files Browse the repository at this point in the history
Signed-off-by: ozkanonur <[email protected]>
  • Loading branch information
onur-ozkan committed Jul 21, 2023
1 parent 685afa1 commit 40fae83
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package search api for lpm repositories
=======================================

**API Configuration**

DB_PATH(required):
- export DB_PATH={repository_db_path_to_be_searched}

API_PORT (optional, default is 8126):
- export API_PORT={CUSTOM_PORT}

**Builds**

Development session
- go run package-search-api.go

Prod-level binary:
- go build -ldflags "-s -w" package-search-api.go

**Endpoints**

Search for latest packages:
- http://127.0.0.1:8126

Search with pattern matching:
- http://127.0.0.1:8126/?package=lz

Healthcheck:
- http://127.0.0.1:8126/health

0 comments on commit 40fae83

Please sign in to comment.