timvoet/web-flask

A python web application template

Your Startr Web App

v0.2.0

WEB-Flask: less than 256 Lines of Python Goodness 🚀

With Startr/WEB-Flast you can turn your ideas into a solid Minimal Viable Product in less than a weekend.

With a little Python code you can tweak our micro framework to do anything.

A simple yet powerful web application built with Flask and sprinkled with love...

🌟🌟🌟 Please fork and leave a ⭐ star if you find this repo useful. Thank you! 🌟🌟🌟

Introduction

Welcome to WEB-Flask, a fantastic web application that will elevate your development experience. This project, powered by Flask, offers an array of features to make your web development journey smooth and delightful.

Getting Started

To begin, make sure you have Python installed on your machine. Clone this repository and navigate to the project directory in your terminal. Then, follow these steps:

1. Install the required dependencies by running pip install -r requirements.txt.
2. Run the app locally using python app.py. The application will be accessible at http://localhost:8000 during development.

License

We license our projects under the AGPL-3.0 license. This license allows you to use, modify, and distribute this work, as long as you give us credit and share any changes you make under the same license. Share your changes by opening a pull request.

WEB-Flask Includes 🛠️

Here's what you'll find in this awesome project:

• ✨ Quick Site with super smooth page transitions
• 🔐 User authentication
• 👥 Members only page logic
• 🎯 Pro members only page logic
• 📝 Contact form
• 📂 File upload
• 💵 Billing
  • 💳 Stripe integration
  • 🔄 Subscriptions
• 📊 User dashboard
• 👩‍💼 User roles
• 🔑 Login
• 🔒 Logout
• 📝 User registration

More details

To ensure you have a seamless experience using WEB-Flask, we've prepared a more detailed description below:

1. Installation: First, follow the "Getting Started" section above to set up the environment and run the app locally.
2. Page Transitions: Explore the super smooth page transitions and enjoy a seamless user experience.
3. Stripe Integration: Learn how to integrate Stripe for payment processing with just a few simple steps.
4. User Authentication: Implement user authentication to secure your app's content.
5. Members Only Logic: Control access to certain pages and make them exclusive to members only.
6. Pro Members Logic: Elevate the experience for pro members with special access and content.
7. Contact Form: Set up a contact form to connect with your users and receive valuable feedback.
8. File Upload: Allow users to upload files effortlessly with this feature.
9. Billing and Subscriptions: Manage billing and subscriptions smoothly for your users.
10. User Dashboard: Create a personalized dashboard for users to monitor their activities and settings.
11. User Roles: Define different user roles for varying levels of access and control.
12. Login and Logout: Enable users to log in and out securely.
13. User Registration: Implement user registration to create accounts for your app.

Get Started Now!

You are all set to embark on an exciting journey with WEB-Flask. Get ready to build amazing web applications with just 256 lines of Python magic. Happy coding! 🎉🐍

Installation

Note: It's a great idea to use a tool like autoenv to manage spinning up your app's env while doing development.

curl -#fLo- 'https://raw.githubusercontent.com/hyperupcall/autoenv/master/scripts/install.sh' | sh

pip install -r requirements.txt

echo export STRIPE_SECRET_KEY="{{ your_stripe_secret_key }}" >> .env
echo export STRIPE_PUBLISHABLE_KEY="{{ your_stripe_publishable_key }}" >> .env
echo export FLASK_SECRET_KEY="{{ your_flask_secret_key }}" >> .env

# Sets a default price for the Pro plan
# Currently, this is a one-time payment

echo export PRO_PRICE="{{ your_pro_price }}" >> .env

# Sets a default price for the Pro plan
# Currently, this is a one-time payment

echo echo "Keys set" >> .env

echo pipenv shell >> .env

Usage

python app.py

Browse to http://localhost:8000 and enjoy!

While in development, the user database is stored in /tmp/users.db. This facilitates easy testing and development. In production, you'll want to change this to a more permanent location.

Deployment

Use Docker to deploy this application. The included Dockerfile will build an image with the application and all dependencies installed.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.