An open API service indexing awesome lists of open source software.

https://github.com/blueorionn/flask-booklist

BookList Collection Web Application.
https://github.com/blueorionn/flask-booklist

Last synced: 3 months ago
JSON representation

BookList Collection Web Application.

Awesome Lists containing this project

README

        

# FLASK BOOKLIST

This project is a Flask-based web application that explores session authentication and middleware. The backend handles user authentication using Flask sessions, enforcing secure login/logout mechanisms, and applying middleware for request validation and logging. This setup provides a structured way to learn about user authentication, middleware functions, and frontend asset management in a Flask environment.

⚠️ This project is created solely for fun and learning

## TechStack

- Flask
- Tailwindcss
- MariaDB

## Installation

### Prerequisites

- Python 3.11+
- pip (Python package installer)

### Steps

1. Clone the repository:

```bash
git clone https://github.com/blueorionn/Flask-BookList.git
cd Flask-BookList
```

2. Create and activate a virtual environment:

```bash
python -m venv .venv
source .venv/bin/activate # On Windows: venv\Scripts\activate
```

3. Install the dependencies:

```bash
pip install -r requirements.txt
```

4. Export variables:

```bash
export PYTHONDONTWRITEBYTECODE=1
export FLASK_ENV="development"
export SECRET_KEY="your-secret-key"
export DB_HOST="your-database-host"
export DB_NAME="your-database-name"
export DB_USERNAME="your-database-username"
export DB_PASSWORD="your-database-password"
export DB_PORT="your-database-port"
```

5. Run the Flask app:

```bash
python wsgi.py
```

6. Open the app in your browser at `http://127.0.0.1:8000/`.

## License

This project is released under the MIT License.