VirtualSlime-API

module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2023 License: MIT

README

VirtualSlime-API

Usage

Setup
git clone https://github.com/HidemaruOwO/VirtualSlime-API
cd VirtualSlime-API

# Edit .env file
vim .env
Test dev (localhost:3001)
VIRTUALSLIME_DIR=~/Code/VirtualSlime DEBUG=true go run src/main.go

Use Product

Build
go build -ldflags="-s -w" -trimpath
mv main virtualslime
Start
APP_ENV=production ./virtualslime

Environment

  • DOMAIN: (need) string Value: Your domain name (ex. v-sli.me)
  • APP_ENV: (product only need) string Value: production
  • PORT: (optional) int16 Value: App listen port (default: 3000)
  • DEBUG: (optional) bool Value: Make Debug Mode (ex. true or false, default: false)
For development
  • VIRTUALSLIME_DIR: (development only need) string Value: VirtualSlime directory (ex. ~/Code/VirtualSlime)

API Documents

  • /v1/posts
GET api.v-sli.me/v1/posts?q=<SearchWord>

?q : Search text : string+string+string....

Directories

Path Synopsis
src
lib

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL