From 3eb062aed5fd70b40f9e5bbc9d981ff83b125cd8 Mon Sep 17 00:00:00 2001 From: James Lee Date: Tue, 19 Apr 2016 18:42:03 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 500b83d..5ab3bc6 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,36 @@ [![Gitter chat](https://badges.gitter.im/uptownhr/hackathon-starter-lite.png)](https://gitter.im/uptownhr/hackathon-starter-lite) [![Coverage Status](https://coveralls.io/repos/github/uptownhr/hackathon-starter-lite/badge.svg?branch=master)](https://coveralls.io/github/uptownhr/hackathon-starter-lite?branch=master) -# hackathon-starter-lite -Taking [Hackathon Starter](https://github.com/sahat/hackathon-starter) to the next level. +# hackable +Personal site starter for express developers. -A framework written with Express. We aim to provide more than just a login boilerplate. +Hackable comes pre-built with an admin that is easy to hack with your express chops. Hackable keeps things familiar and uses libraries common to express developers. No new API's to learn - no magic. + +The goal of the project is to provide you with a hackable prototype that you can mold to your liking. + +If you've been thinking about creating a personal site or a site for your project, give Hackable a shot!. + + +## Main Stack +- Mongoose +- Pug (previously known as Jade) +- Passport ## Features - Login + - Email / Password + - Twitter, Github, Facebook, Gmail - Admin -- Posts -- Projects -- Products -- Files + - Users + - Posts + - Projects + - Products + - Files +- Website + - Landing Page + - Projects + - Products + - Blog ## Getting Started The easiest way to get started and workflow we recommend is by using docker. Docker handles the service depencies for the application to run. For example, Mongodb and Redis will be started and connected using containers. You do not have to worry about installation steps or muddying your host machine with additional services. From bc47348172c37e7dadb03be037ee6def35a656c6 Mon Sep 17 00:00:00 2001 From: James Lee Date: Tue, 19 Apr 2016 18:50:45 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ab3bc6..edec4b8 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ If you've been thinking about creating a personal site or a site for your projec - Blog ## Getting Started -The easiest way to get started and workflow we recommend is by using docker. Docker handles the service depencies for the application to run. For example, Mongodb and Redis will be started and connected using containers. You do not have to worry about installation steps or muddying your host machine with additional services. +The easiest way to get started and the workflow we recommend is using docker. Docker handles the service depencies for the application to run. For example, Mongodb and Redis will be started and connected to the application automaticlaly. You do not have to worry about installation steps or muddying your host machine with additional services. If you have docker available, you can get started in two steps.