Skip to content
Permalink
Browse files

Update docs

  • Loading branch information...
nlaz committed Feb 22, 2019
1 parent 7b036d0 commit 74a31e92cf51f8210814b5b0645fe966e51f2e21
Showing with 9 additions and 9 deletions.
  1. +4 −4 README.md
  2. +5 −5 docs/USER_GUIDE.md
@@ -14,7 +14,7 @@ This project requires the following tools:
* PostgreSQL - A relational database system.
* Virtualenv - A tool for creating isolated Python environments.

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/).
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

@@ -42,7 +42,7 @@ Next, we need to install the project dependencies, which are listed in `requirem

**Step 3: Create an app on GitHub**

Head over to [GitHub OAuth apps](https://github.com/settings/developers) and create a new OAuth app. Name it what you like but you'll need to specify a callback url, which should be something like:
Head over to [GitHub OAuth apps](https://github.com/settings/developers) and create a new OAuth app. Name it what you like but you'll need to specify a callback URL, which should be something like:

```
https://localhost:5000/auth/callback/github
@@ -61,7 +61,7 @@ GITHUB_CLIENT_ID="[INSERT_CLIENT_ID]"
GITHUB_CLIENT_SECRET="[INSERT_CLIENT_SECRET]"
```

You replace the GitHub credentials here and update the database url. Learn more about the required [Environment Variables here](#environment-variables).
You replace the GitHub credentials here and update the database URL. Learn more about the required [Environment Variables here](#environment-variables).

Now we're ready to start our server which is as simple as:

@@ -80,7 +80,7 @@ You will see the build errors and warnings in the console.
* [Flask Blueprints](http://flask.pocoo.org/docs/1.0/blueprints/) - A Flask extension for making modular applications
* [Flask-SQLAlchemy](http://flask-sqlalchemy.pocoo.org/2.3/) - A Flask extension that adds ORM support for your data models.
* [Flask-Misaka](https://flask-misaka.readthedocs.io) - A Flask extension that supports rendering markdown into HTML.
* [Werkzeug](http://werkzeug.pocoo.org/) - A Flask framework that implements WSGI for handling server requests.
* [Werkzeug](http://werkzeug.pocoo.org/) - A Flask framework that implements WSGI for handling requests.
* [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.

@@ -6,7 +6,7 @@ If you think we are missing something or you have ideas for more guides that sho

## How It Works

This project simply provides the boilerplate to get started with a new Flask application. It provides the tools and guides to get started quickly. You can use this project as a starting point to building new applications during a hackathon.
This project simply provides the boilerplate to get started with a new Flask application. It provides the tools and guides to get started quickly. You can use this project as a starting point for building new applications during a hackathon.

Even if you are not using it for a hackathon, it should save you time getting started building and learning Flask development.

@@ -37,7 +37,7 @@ Next, we need to install the project dependencies, which are listed in `requirem

**Step 3: Create an app on GitHub**

Head over to [GitHub OAuth apps](https://github.com/settings/developers) and create a new OAuth app. Name it what you like but you'll need to specify a callback url, which should be something like:
Head over to [GitHub OAuth apps](https://github.com/settings/developers) and create a new OAuth app. Name it what you like but you'll need to specify a callback URL, which should be something like:

```
https://localhost:5000/auth/callback/github
@@ -56,7 +56,7 @@ GITHUB_CLIENT_ID="[INSERT_CLIENT_ID]"
GITHUB_CLIENT_SECRET="[INSERT_CLIENT_SECRET]"
```

You replace the GitHub credentials here and update the database url. Learn more about the required [Environment Variables here](#environment-variables).
You replace the GitHub credentials here and update the database URL. Learn more about the required [Environment Variables here](#environment-variables).

Now we're ready to start our server which is as simple as:

@@ -130,7 +130,7 @@ The tradeoff is that you have to go through the [GitHub OAuth flow](https://deve
5. Your app uses GitHub's API with the stored access token.

The code that handles this process is contained in `views/auth.py` and `services/github.py`.
To use this authentication technique you need to setup a new GitHub OAuth app. [Instructions listed below](#github-oauth).
To use this authentication technique you need to create a new GitHub OAuth app. [Instructions listed below](#github-oauth).

## Fetching Data

@@ -212,7 +212,7 @@ GITHUB_CLIENT_ID="[INSERT_CLIENT_ID]"
GITHUB_CLIENT_SECRET="[INSERT_CLIENT_SECRET]"
```

The `DATABASE_URL` variable is the path to your database system. This is where you can add the url to your PostgreSQL.
The `DATABASE_URL` variable is the path to your database system. This is where you can add the URL to your PostgreSQL.

The `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` variables are the app credentials from your [GitHub OAuth app](https://github.com/settings/developers).

0 comments on commit 74a31e9

Please sign in to comment.
You can’t perform that action at this time.