diff --git a/README.md b/README.md new file mode 100644 index 0000000..ceb7cc9 --- /dev/null +++ b/README.md @@ -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.