syrell/chirpy_server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Added more context in README

Browse Source
This commit is contained in:
syrell 2024-10-31 21:31:34 +01:00
parent 72581d912e
commit fc6d737398
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.adoc
View File

@ -1,3 +1,12 @@
= Chirpy Server
This repository holds my version of https://boot.dev[boot.dev] HTTP Servers course.
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