Skip to content

Backbone for the 2024 NCKU Bike Festival ๐ŸŽ‰, featuring event notifications ๐Ÿ“ข, API docs ๐Ÿ“„, and Line Login for authentication ๐Ÿ”‘. Built with Go, Docker, and Redis, it guides on setting up databases, running servers, and pushing notifications ๐Ÿ“ฒ.

peterxcli/bike-festival-2024-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Bike-Festival-2024

API Document

Line Login

Official Document

Tutorial

1. Line Login Integration Tutorial

Branch/Commit Type

  • feat: ๆ–ฐๅขž/ไฟฎๆ”นๅŠŸ่ƒฝ (feature)ใ€‚
  • fix: ไฟฎ่ฃœ bug (bug fix)ใ€‚
  • docs: ๆ–‡ไปถ (documentation)ใ€‚
  • style: ๆ ผๅผ (ไธๅฝฑ้Ÿฟ็จ‹ๅผ็ขผ้‹่กŒ็š„่ฎŠๅ‹• white-space, formatting, missing semicolons, etc.)ใ€‚
  • refactor: ้‡ๆง‹ (ๆ—ขไธๆ˜ฏๆ–ฐๅขžๅŠŸ่ƒฝ๏ผŒไนŸไธๆ˜ฏไฟฎ่ฃœ bug ็š„็จ‹ๅผ็ขผ่ฎŠๅ‹•)ใ€‚
  • perf: ๆ”นๅ–„ๆ•ˆ่ƒฝ (A code change that improves performance)ใ€‚
  • test: ๅขžๅŠ ๆธฌ่ฉฆ (when adding missing tests)ใ€‚
  • chore: ๅปบๆง‹็จ‹ๅบๆˆ–่ผ”ๅŠฉๅทฅๅ…ท็š„่ฎŠๅ‹• (maintain)ใ€‚
  • revert: ๆ’ค้Šทๅ›ž่ฆ†ๅ…ˆๅ‰็š„ commit

e.g

  • feat/auth, refactor/home-layout
  • feat: build button component, fix indentation and spacing issues

dev setup

  1. Make sure you have installed make, go and docker-compose / docker compose on your machine

  2. Copy .env.example to .env.dev and modify the environment variables if needed

    cp .env.example .env.dev
  3. Run make install to install the tools

    Run only once when you start the development or the tools required to be updated

  4. Run make dev-up to start the development database and redis [//]: # (5. Run make dev-migrate to migrate the database)

  5. Run make run to start the development server with no live reload

    Run make serve to start the development server with live reload(but requires air to be installed)

    1. Webserver will be listening on localhost:8000, you may change the port in .env.dev
  6. Run make dev-down to stop the development database and redis

Event Notification Server

Push upcoming event notification to the users who subscribed to the event

make bot

About

Backbone for the 2024 NCKU Bike Festival ๐ŸŽ‰, featuring event notifications ๐Ÿ“ข, API docs ๐Ÿ“„, and Line Login for authentication ๐Ÿ”‘. Built with Go, Docker, and Redis, it guides on setting up databases, running servers, and pushing notifications ๐Ÿ“ฒ.

Resources

Stars

Watchers

Forks

Packages

No packages published