Skip to content

Commit 2da8d33

Browse files
committed
[readme] Add notes on usage + deployment platforms
1 parent b176891 commit 2da8d33

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ Originally developed for [BrickHack](https://github.com/codeRIT/brickhack.io), t
1818

1919
**_HackathonManager is in the midst of a significant change to how it's deployed. If you're looking to use this *right now,* reach out to [Stuart Olivera](https://github.com/sman591)_**
2020

21+
HackathonManager is intended to be a standalone web app separate from your regular marketing website/public homepage. A typical setup would be:
22+
23+
- **brickhack.io** — Marketing site with event info, schedule, sponsors, etc and a button to apply
24+
- **apply.brickhack.io** — HackathonManager deployment to accept hacker applications + host management dashboard
25+
26+
This allows your public marketing site to operate however you want it (e.g. GitHub pages) while HackathonManager lives in an isolated, consistent environment.
27+
2128
HackathonManager uses a variety of third-party services & Ruby gems:
2229

2330
- [Devise](https://github.com/plataformatec/devise) + [MyMLH](https://my.mlh.io/) (authentication & attendee identity)
@@ -43,7 +50,12 @@ Be sure to review all of these before going live!
4350

4451
## Deployment
4552

46-
Deployment to Heroku and Dokku is supported out of the box, though anything that operates on Heroku's buildpacks should work too.
53+
HackathonManager supports two platforms out of the box:
54+
55+
- [Heroku](https://www.heroku.com) — Easiest & quickest way that requires little server knowledge, however isn't cheap (can't run on free tier)
56+
- [Dokku](http://dokku.viewdocs.io/dokku/) — A free alternative to Heroku, runs on your own virtual machine.
57+
58+
HackathonManager can also be deployed the same as any other Rails app, however this is **not** natively supported and will require you to fork this repo to integrate code changes.
4759

4860
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
4961

0 commit comments

Comments
 (0)