My Flask Blog Project

This is a project to show the usage of various libraries revolving mainly around Flask and Bootstrap. See here for all libraries and frameworks used in this project.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contact

About The Project

This is a project to show the usage of various libraries revolving mainly around Flask and Bootstrap. See here for all libraries and frameworks used in this project.

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you can setup your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/PotatoCodez127/MyBlogProject.git

2. Create a .env file for environment variables

3. Create a Flask_SECRET_KEY vairable for the secret key

   Flask_SECRET_KEY = 'RANDOM STRING FOR KEY';
   

4. Inside the main.py replace line 48 and 49

   OWN_EMAIL = "YOUR OWN EMAIL ADDRESS"
   OWN_PASSWORD = "YOUR EMAIL ADDRESS PASSWORD"
   

   With your own email adress and set up an app password through google for your Flask app for the password field.

(back to top)

Roadmap

• Create basic Blog application with Flask.
• Add Bootstrap into HTML templates and page routing.
• Create an API endpoint to display blog data
• Add CRUD operations
• Add dynamic data to HTML templates using Jinja
• Create a SQLite database and impliment SQLAlchemy
• Create User authentication
• Create forms with Flask-wtf to 'Sign up' and 'Log-in'
• Add security to encrypt or hash passwords with Werkzeug
• Add administrator roles so users cannot add/delete/ posts
• Add a comment section to posts
• Deploy website

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

My email adress: jeandre.c127@gmail.com

Project Link: https://github.com/PotatoCodez127/MyBlogProject

(back to top)