Add a basic README

This commit is contained in:
Sage Vaillancourt 2023-05-03 23:12:25 +00:00
parent b03ee285a2
commit 77868b4f9b
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# UnderCover.Cafe
undercover.cafe is a site designed to act as a simple interface for generating
templated cover letters.
The site is built on Flask, with a very simple VanillaJS frontend, and
leverages LaTeX for document generation. User data, including logins and stored
templates, is stored in postgres, with bcrypt-hashed credentials.
## Deployment
While not implemented as part of this repo, the site itself uses a pseudo
blue/green deployment system, with Testing and Production both running on one
server. A simple script toggles the proxy between pointing visitors to the blue
or the green instance.