chirpy_server/README.adoc

= Chirpy Server

This repository holds my version of https://boot.dev[boot.dev] HTTP Servers course. It consists in an API where users can log in and send messages (chirps).

== Get started

Chirpy relies on a Postgres database (the database should be created first). Needed environment variables are:

* DB_URL: Postgres URL connection
* PLATFORM: dev, on purpose of the course
* JWT_SECRET: can be generated using `openssl rand -base64 64`
* POLKA_KEY: predefined dummy API key used to illustrate webhook feature

In order to modify DB schema/queries additional libraries are also needed:

[source,shell]
----
$ go install github.com/pressly/goose/v3/cmd/goose@latest
$ go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
----
feat: Initial commit 2024-10-09 23:11:05 +02:00			`= Chirpy Server`

chore: Added more context in README 2024-10-31 21:31:34 +01:00			`This repository holds my version of https://boot.dev[boot.dev] HTTP Servers course. It consists in an API where users can log in and send messages (chirps).`

			`== Get started`

			`Chirpy relies on a Postgres database (the database should be created first). Needed environment variables are:`

			`* DB_URL: Postgres URL connection`
			`* PLATFORM: dev, on purpose of the course`
			* JWT_SECRET: can be generated using `openssl rand -base64 64`
chore: Added needed packages to update DB stuff 2024-10-31 21:49:03 +01:00			`* POLKA_KEY: predefined dummy API key used to illustrate webhook feature`

			`In order to modify DB schema/queries additional libraries are also needed:`

			`[source,shell]`
			`----`
			`$ go install github.com/pressly/goose/v3/cmd/goose@latest`
			`$ go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest`
			`----`