https://github.com/tecladocode/simple-flask-template-app

A simple Flask app that uses render_template, to teach different features of Flask.
https://github.com/tecladocode/simple-flask-template-app

Last synced: 17 days ago
JSON representation

A simple Flask app that uses render_template, to teach different features of Flask.

• Host: GitHub
• URL: https://github.com/tecladocode/simple-flask-template-app
• Owner: tecladocode
• Created: 2019-07-04T14:27:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T06:34:35.000Z (almost 2 years ago)
• Last Synced: 2024-12-29T08:43:59.178Z (20 days ago)
• Language: HTML
• Size: 14.6 KB
• Stars: 9
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple Flask Template App

This short code repository shows how a Flask application that serves HTML files may be created.

It is used in our blog post, "How to add user logins to your Flask website". Read that for more info!

## Installing

You'll need `flask` to run this code sample. Install it like so:

```

pipenv install flask

```

## The app

Creating a Flask app is simple. Here we create one and also give it a `secret_key`. This is used for securing the cookies that the Flask app sends to each user.

```python

from flask import Flask, render_template, session

app = Flask(__name__)

app.secret_key = "jose"

```

## The users

In this Flask application we have a list of users. We use these to implement authentication (login and signup) in the app. We do that in the blog post.

```python

users = {"jose": ("jose", "1234")}

```

This is a mapping of usernames to user data. This allows us to access `users[username]` when a user sends us their username.

It means we won't have to search through a list of users when we get a user's username.

## The routes

We have three pages in this starter app: `home`, `login`, and `register`.

At the moment these only return HTML pages (from the `templates` folder). In the blog post we modify two of them to actually deal with user data.

```python

@app.route("/")

def home():

    return render_template("home.jinja2")

@app.route("/login")

def login():

    # Here you could deal with the user's username and password.

    # Check if they're correct.

    return render_template("login.jinja2")

@app.route("/register")

def register():

    # Here you could register the user.

    # Add them to a database, for example.

    return render_template("register.jinja2")

```

## Running the app

To run this app, enter the Pipenv shell and run the app via the Flask CLI. Make sure you're in the correct directory first:

```

pipenv shell

flask run

```