mirror of https://github.com/ProjectSegfault/publapi.git synced 2024-06-15 01:01:57 +05:30

API for our pubnix

Go to file

Arya Kiran 426e965ff5 apparently you dont need the xtra dashes on gfm		2023-01-08 09:25:31 +05:30
pages	dont print the script to stdout when signup request is made	2023-01-08 09:17:19 +05:30
.gitignore	remove binary wtf	2023-01-07 19:16:48 +01:00
go.mod	Switch logger	2023-01-07 17:54:04 +01:00
go.sum	Switch logger	2023-01-07 17:54:04 +01:00
LICENSE	Arya fix it	2023-01-07 16:33:51 +01:00
main.go	Fix newline escape character on /online	2023-01-07 19:43:20 +01:00
README.md	apparently you dont need the xtra dashes on gfm	2023-01-08 09:25:31 +05:30

PublAPI

PublAPI is a simple API for Project Segfault's public shared system (pubnix).

Install

An installation of Go 1.19 or higher is required.

git clone https://github.com/ProjectSegfault/publapi
go mod download 
go build 
./publapi

By default it listens to port 3000 on 127.0.0.1. You can change the port with the environment variable PUBLAPI_PORT.

Currently, PublAPI has only two routes, /online and /signup.

ROUTE	TYPE	EXTRA ARGS	DESCRIPTION
/online	GET	N/A	Returns the number of online users
/signup	POST	username, email	Creates a register script and notifies admins that a new registration request was sent