Skip to content
This repository has been archived by the owner. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 40 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
# Introduction
<h1 align="center">
MLH Hackathon Flask Starter
</h1>

<img src="https://user-images.githubusercontent.com/9976294/68912486-4837f580-0726-11ea-93d5-46d10f866775.png" alt="Screencapture" align="center"/>


<h2 align="center">
<a href="https://hackathon-starter-python.herokuapp.com/">> View Demo <</a>
</h2>


## Table of Contents
<!-- ⛔️ MD-MAGIC-EXAMPLE:START (TOC:collapse=true&collapseText=Click to expand) -->
<details>
<summary>Click to expand</summary>

1. [Introduction](#1-introduction)
2. [Installation Guide](#2-installation-guide)
3. [What's Included?](#3-whats-included)
4. [Code of Conduct](#4-code-of-conduct)
5. [License](#5-license)

</details>
<!-- ⛔️ MD-MAGIC-EXAMPLE:END -->

## 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.

- [Installation Guide](#installation-guide) - How to get started with a new Flask app
- [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

# <a name='installation-guide'>Installation Guide</a>
## 2 Installation Guide

This project requires the following tools:

Expand All @@ -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
### 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
```
Expand All @@ -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
```

Expand Down Expand Up @@ -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
```

Expand All @@ -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
Expand All @@ -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).

<p align="center">
🌟 PLEASE STAR THIS REPO IF YOU FOUND SOMETHING INTERESTING 🌟
</p>