From d8b498221f14434bdebfe687cad0b2ce5c0e2c1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Egill=20Anton=20Hl=C3=B6=C3=B0versson?= Date: Thu, 14 Nov 2019 21:02:49 -0500 Subject: [PATCH 1/5] Markdown Magic added to READEME --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 40 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index afcf162..46cf354 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -# Introduction +

+MLH Hackathon Flask Starter +

+ +Screencapture + + +

+Live Demo +

+ + +## Table of Contents + +
+Click to expand + +1. [Introduction](#1-introduction) +2. [Installation Guide](#2-installation-guide) +3. [What's Included?](#3-whats-included?) +4. [Code of Conduct](#4-license) +5. [License](#5-references) + +
+ + +## 1 Introduction This is a hackathon boilerplate for new Flask web applications created by [Major League Hacking](https://github.com/MLH). It is for hackers looking to get started quickly on a new hackathon project using the Flask microframework. @@ -6,7 +32,7 @@ This is a hackathon boilerplate for new Flask web applications created by [Major - [User Guide](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/USER_GUIDE.md) - How to develop apps created with this starter project - [Contributing Guide](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/CONTRIBUTING.md) - How to contribute to the project -# Installation Guide +## 2 Installation Guide This project requires the following tools: @@ -16,11 +42,11 @@ This project requires the following tools: To get started, install Python and Postgres on your local computer if you don't have them already. A simple way for Mac OS X users to install Postgres is using [Postgres.app](https://postgresapp.com/). You can optionally use another database system instead of Postgres, like [SQLite](http://flask.pocoo.org/docs/1.0/patterns/sqlite3/). -## Getting Started +### 2.1 Getting Started **Step 1. Clone the code into a fresh folder** -``` +```bash $ git clone https://github.com/MLH/mlh-hackathon-flask-starter.git $ cd mlh-hackathon-flask-starter ``` @@ -29,14 +55,14 @@ $ cd mlh-hackathon-flask-starter Create a new Virtual Environment for the project and activate it. If you don't have the `virtualenv` command yet, you can find installation [instructions here](https://virtualenv.readthedocs.io/en/latest/). Learn more about [Virtual Environments](http://flask.pocoo.org/docs/1.0/installation/#virtual-environments). -``` +```bash $ virtualenv venv $ source venv/bin/activate ``` Next, we need to install the project dependencies, which are listed in `requirements.txt`. -``` +```bash (venv) $ pip install -r requirements.txt ``` @@ -75,7 +101,7 @@ You replace the GitHub credentials here and update the database URL. Learn more Now we're ready to start our server which is as simple as: -``` +```bash (venv) $ flask run ``` @@ -84,7 +110,7 @@ Open http://localhost:5000 to view it in your browser. The app will automatically reload if you make changes to the code. You will see the build errors and warnings in the console. -# What's Included? +## 3 What's Included? - [Flask](http://flask.pocoo.org/) - A microframework for Python web applications - [Flask Blueprints](http://flask.pocoo.org/docs/1.0/blueprints/) - A Flask extension for making modular applications @@ -93,10 +119,14 @@ You will see the build errors and warnings in the console. - [Bootstrap 4](https://getbootstrap.com/) - An open source design system for HTML, CSS, and JS. - [Jinja2](http://jinja.pocoo.org/docs/2.10/) - A templating language for Python, used by Flask. -# Code of Conduct +## 4 Code of Conduct We enforce a Code of Conduct for all maintainers and contributors of this Guide. Read more in [CONDUCT.md](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/CONDUCT.md). -# License +## 5 License The Hackathon Starter Kit is open source software [licensed as MIT](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/LICENSE.md). + +

+🌟 PLEASE STAR THIS REPO IF YOU FOUND SOMETHING INTERESTING 🌟 +

\ No newline at end of file From 9161ee07a0ec7f0620468949de81164605998105 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Egill=20Anton=20Hl=C3=B6=C3=B0versson?= Date: Thu, 14 Nov 2019 21:05:00 -0500 Subject: [PATCH 2/5] Markdown Magic added to READEME --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 46cf354..d23b7bc 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,9 @@ MLH Hackathon Flask Starter 1. [Introduction](#1-introduction) 2. [Installation Guide](#2-installation-guide) -3. [What's Included?](#3-whats-included?) -4. [Code of Conduct](#4-license) -5. [License](#5-references) +3. [What's Included?](#3-whats-included) +4. [Code of Conduct](#4-code-of-conduct) +5. [License](#5-license) From 15eaa7f111beb23dbe3a500250dfda8c63a4510c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Egill=20Anton=20Hl=C3=B6=C3=B0versson?= Date: Thu, 14 Nov 2019 21:21:00 -0500 Subject: [PATCH 3/5] Dropshaddow Added --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d23b7bc..6240448 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MLH Hackathon Flask Starter -Screencapture +Screencapture

From 8438752b2dd5c9d474b7a5a345c851dbb4084b8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Egill=20Anton=20Hl=C3=B6=C3=B0versson?= Date: Thu, 14 Nov 2019 21:22:34 -0500 Subject: [PATCH 4/5] View Demo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6240448..21e3f19 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ MLH Hackathon Flask Starter

-Live Demo +> View Demo <

From 371cd04ce97e4fb2b16a576dbc846b0048367114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Egill=20Anton=20Hl=C3=B6=C3=B0versson?= Date: Thu, 14 Nov 2019 21:33:39 -0500 Subject: [PATCH 5/5] Screencapture --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21e3f19..54d9a52 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MLH Hackathon Flask Starter

-Screencapture +Screencapture

@@ -42,7 +42,7 @@ This project requires the following tools: To get started, install Python and Postgres on your local computer if you don't have them already. A simple way for Mac OS X users to install Postgres is using [Postgres.app](https://postgresapp.com/). You can optionally use another database system instead of Postgres, like [SQLite](http://flask.pocoo.org/docs/1.0/patterns/sqlite3/). -### 2.1 Getting Started +### Getting Started **Step 1. Clone the code into a fresh folder**