The hoshiro from gifaldyazkaa

hoshiro's Introduction

Caution

This project has shutdown and this repository has archived. All core functions of this application are unavailable and inaccessible. Thank you for using my application!

🚦 Endpoints

Base URL: https://api.hoshiro.space

Available regions: Indonesia (id), Malaysia (my), Singapore (sg).

Route	Method	Parameters	Required	Examples
`/auth/register`	POST	`username`, `password`	Yes	`johndoe`, `john123`
`/auth/login`	POST	`username`, `password`	Yes	`johndoe`, `john123`
`/:region`	GET	-	-	`/id`
`/:region`	POST	`...`	Yes	`/id`
`/:region`	PATCH	`...`	Yes	`/id`
`/:region/active`	GET	-	-	`/sg/active`
`/:region/graduated`	GET	-	-	`/my/graduated`
`/:region/:handle`	GET	`/:handle`	Yes	`/id/@amayaclorentine`

➡️ Development

🛠️ Requirements

A bun.sh >= 1.0.20 setup with node.js >= 16.x (for production) is recommended.

📦 Install dependencies

$ bun install

📝 Create environment file

MONGODB_URI="your mongodb connection uri"
SECRET_SESSION="hashed secret string"
DISCORD_CLIENT_ID="discord client id"
DISCORD_CLIENT_SECRET="discord client secret"
DISCORD_REDIRECT_URI="discord redirect uri"

🚀 Start development server

$ bun run dev
#
# [INFO] App connected to MongoDB Atlas!
# [INFO] Express server has been started! (Live at port xxxx)

💖 Thanks to

Bun.sh for their super-fast runtime
GitHub Codespaces and Project IDX for providing their fast developer environment
Microsoft Azure for offering a Windows Virtual Machine to host this Backend API
@BayuDC for the code, and ideas contribution
Agis Lugandi and Shigure for their contributions on suggesting some new project name