Chirpy

A toy server built in go. Uses a local json as DB (I know, sue me!)

How to run

Setup the repo:

sh setup.sh

Hit the following cmd:

sh runServer.sh

And play around with the endpoints.

Or else use the following to run the server in Debug mode. This nukes the database.

sh runServer.sh --debug

Endpoints

• [GET] /api/healthz : Check the health of the server

• [GET] /api/metrics : Check hit metrics of server

• [GET] /app : Homepage

• [GET] /app/assets : Fileserver for assets

• [GET] /api/chirps : Get all the chirps in the DB

  • On providing query param author_id, Get all chirps in the DB against that author
  • On providing query param sort, Get all chirps in sorted format. By default, sort is ascending. For descending sort, provide value desc

• [GET] /api/chirps/{id} : Get a particular chirp in the DB

• [POST] /api/chirps : Create a new chirp in the DB

• [GET] /api/users : Get all the users in the DB

• [GET] /api/users/{id} : Get a particular user in the DB

• [POST] /api/users : Create a new user in the DB

• [POST] /api/login: Login as a user. Returns User details, along with auth tokens

• [POST] /api/refresh: Get a refreshed access token. Requires Refresh token in header

• [POST] /api/revoke: Revokes a refresh token

• [POST] /api/polka/webhooks: Webhook for our Payment Provider, Polka, that upgrades user to our vaporware program, Chirpy Red

• [PUT] /api/users: Update details of a user. Requires a valid access token

• [DELETE] /api/chirps/{chirpid}: Deletes a chirp by chirp id. Needs authorized access token matching the author of chirp