Closes #1

Increase gap between title bar and header
Fix premature loading of static folder path
2023-07-28 19:47:32 +05:30 · 2023-07-17 16:02:17 +00:00 · 2023-07-16 16:44:14 +00:00 · 2023-07-13 04:50:10 +00:00 · 2023-07-12 10:18:41 +00:00 · 2023-07-12 15:40:32 +05:30
8 changed files with 63 additions and 13 deletions
--- a/README.md
+++ b/README.md
@ -10,7 +10,20 @@ Use `gunicorn -w 2 'flaskr:create_app()'` to run app. Increase the number of wor
 ## Initializing database
 The first time you install the app in each environment, you need to initialize database using `flask --app flaskr init-db`. This only needs to be run once per environment, and **will delete existing database if run again**.

-## Secret key
+## Config file
+
+The config file is located at `<python_environment>/var/flaskr-instance/config.py` in production, and in `instance/` in development. The instance folder is created when the database is initialized.
+
+### Secret Key
 Every website with login needs a secret key to hash passwords with.
-`<python_environment>/var/flaskr-instance/config.py` must contain a line `SECRET_KEY = '<secret_key>`, which must be randomly generated.  
+The config file must contain a line `SECRET_KEY = '<secret_key>`, which must be randomly generated.  
 Suggested way of generating the key is `python -c 'import secrets; print(secrets.token_hex())'`, which returns a hexadecimal string with length 64. You may choose to randomly generate a key using a different method, but ensure that it is resistant to brute-force attacks.
+
+### Registration
+Since this blog is meant to be updated by a limited number of people, registration is forbidden (403) by default. In addition, registration (/auth/register) and login (/auth/login) URLs are not hyperlinked anywhere. Registration can be opened by including `REGISTER = True`, and is closed by default.
+
+### Name
+The default app name is "Flaskr", and it is visible on the header bar as well as the page title. Including a line `NAME = '<name>'` in the config file replaces "Flaskr" with your chosen name.
+
+### Static folder
+The default static folder is the one included in the repository. You can use a separate static folder to use your own assets by including a line `STATIC_FOLDER = '<absolute/path/to/folder>'` in the config file.
--- a/flaskr/init.py
+++ b/flaskr/init.py
@ -8,6 +8,8 @@ def create_app(test_config=None):
    app.config.from_mapping(
        SECRET_KEY='dev',
        DATABASE=os.path.join(app.instance_path, 'flaskr.sqlite'),
+        REGISTER=False,
+        NAME='Flaskr'
    )

    app.wsgi_app = ProxyFix(
@ -21,6 +23,9 @@ def create_app(test_config=None):
        # load the test config if passed in
        app.config.from_mapping(test_config)

+    if app.config.get('STATIC_FOLDER') is not None:
+        app.static_folder = app.config.get('STATIC_FOLDER')
+
    # ensure the instance folder exists
    try:
        os.makedirs(app.instance_path)
--- a/flaskr/auth.py
+++ b/flaskr/auth.py
@ -1,7 +1,7 @@
 import functools

 from flask import (
-    Blueprint, flash, g, redirect, render_template, request, session, url_for
+    Blueprint, flash, g, redirect, render_template, request, session, url_for, current_app, abort
 )
 from werkzeug.security import check_password_hash, generate_password_hash

@ -11,6 +11,8 @@ bp = Blueprint('auth', __name__, url_prefix='/auth')

@bp.route('/register', methods=('GET', 'POST'))
 def register():
+    if not current_app.config['REGISTER']:
+        abort(403)
    if request.method == 'POST':
        username = request.form['username']
        password = request.form['password']
--- a/flaskr/blog.py
+++ b/flaskr/blog.py
@ -66,6 +66,13 @@ def get_post(id, check_author=True):

    return post

+@bp.route('/<int:id>')
+def post(id):
+    post = get_post(id, check_author=False)
+    post = dict(post)
+    post['body'] = markdown.markdown(post['body'])
+    return render_template('blog/post.html', post=post)
+
@bp.route('/<int:id>/update', methods=('GET', 'POST'))
@login_required
 def update(id):
@ -101,3 +108,7 @@ def delete(id):
    db.execute('DELETE FROM post WHERE id = ?',(id,))
    db.commit()
    return redirect(url_for('blog.index'))
+
+@bp.route('/temp')
+def temp():
+    return render_template('temp.html')
--- a/flaskr/templates/base.html
+++ b/flaskr/templates/base.html
@ -1,19 +1,19 @@
 <!doctype html>
-<title>{% block title %}{% endblock %} - Flaskr</title>
+<title>{% block title %}{% endblock %} - {{ config['NAME'] }}</title>
 <link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
 <link rel="icon" type="image/png" href="{{ url_for('static', filename='favicon.png') }}">
 <nav>
-  <h1>Flaskr</h1>
+  <h1>{{ config['NAME'] }}</h1>
  <ul>
    {% if g.user %}
      <li><span>{{ g.user['username'] }}</span>
      <li><a href="{{ url_for('auth.logout') }}">Log Out</a>
-    {% else %}
-      <li><a href="{{ url_for('auth.register') }}">Register</a>
-      <li><a href="{{ url_for('auth.login') }}">Log In</a>
    {% endif %}
  </ul>
 </nav>
+</br>
+</br>
+</br>
 <section class="content">
  <header>
    {% block header %}{% endblock %}
--- a/flaskr/templates/blog/index.html
+++ b/flaskr/templates/blog/index.html
@ -12,14 +12,13 @@
    <article class="post">
      <header>
 	<div>
-	  <h1>{{ post['title'] }}</h1>
+	  <h1><a href="{{ url_for('blog.post', id=post['id']) }}">{{ post['title'] }}</a></h1>
 	  <div class="about">by {{ post['username'] }} on {{ post['created'].strftime('%Y-%m-%d') }}</div>
 	</div>
 	{% if g.user['id'] == post['author_id'] %}
-	  <a class="action" href="{{ url_for('blog.update', id=post['id']) }}">Edit</a>
-	  {% endif %}
+	  <a href="{{ url_for('blog.update', id=post['id']) }}">Edit</a>
+	{% endif %}
      </header>
-      <p class="body">{{ post['body']|safe }}</p>
    </article>
    {% if not loop.last %}
      <hr>
--- a/flaskr/templates/blog/post.html
+++ b/flaskr/templates/blog/post.html
@ -0,0 +1,20 @@
+{% extends 'base.html' %}
+
+{% block header %}
+  <h1>{% block title %}{{ post['title']}}{% endblock %}</h1>
+{% endblock %}
+
+{% block content %}
+  <article class="post">
+    <header>
+      <div>
+        <h1>{{ post['title'] }}</h1>
+	<div class="about">by {{ post['username'] }} on {{ post['created'].strftime('%Y-%m-%d') }}</div>
+      </div>
+      {% if g.user['id'] == post['author_id'] %}
+      <a class="action" href="{{ url_for('blog.update', id=post['id']) }}">Edit</a>
+      {% endif %}
+    </header>
+    <p class="body">{{ post['body']|safe }}</p>
+  </article>
+{% endblock %}    
--- a/requirements.txt
+++ b/requirements.txt
@ -8,7 +8,7 @@ dnspython==2.3.0
 email-validator==2.0.0.post2
 exceptiongroup==1.1.1
 Flask==2.3.2
-e git+https://gitlab.com/pvtejas/based4tech.git@4be89bd767a7c5a84ab62fbf4ad924ae1af077f1#egg=flaskr
+-e git+https://gitlab.com/pvtejas/based4tech.git@bda624e4dc1cf97ba2b5b3fcb66a5b28398307bc#egg=flaskr
 gunicorn==20.1.0
 h11==0.14.0
 httpcore==0.17.0
Author	SHA1	Message	Date
Punnamaraju Vinayaka Tejas	00f7c1de33	Closes #1	2023-07-28 19:47:32 +05:30
PV Tejas	57df913a2c	Increase gap between title bar and header	2023-07-17 16:02:17 +00:00
PV Tejas	0b2f0378c1	Fix premature loading of static folder path	2023-07-16 16:44:14 +00:00
PV Tejas	83582435e9	Update README.md with details on config.py in development environments	2023-07-13 04:50:10 +00:00
PV Tejas	b18140c483	Update README.md	2023-07-12 10:18:41 +00:00
Punnamaraju Vinayaka Tejas	a5b0de8c70	Fixed spurious commit hash in requirements.txt	2023-07-12 15:40:32 +05:30
Punnamaraju Vinayaka Tejas	bda624e4dc	Closes #6	2023-07-12 15:37:40 +05:30
Punnamaraju Vinayaka Tejas	de094d4bed	Closes #2 and #3	2023-07-12 12:51:39 +05:30