DEV Community

Ethan Zerad
Ethan Zerad

Posted on

My pet project - what do you guys think?

Hey everyone, a short overview of what I've been doing for the past 84 days: I am taking the 100 Days of Code Python course by Angela Yu on Udemy, and during this course, I learned Flask and created a simple blog using it.

For the past 15 days, I've been working on improving that blog and creating a management system that could allow a user with no experience in coding whatsoever to configure and manage his website from A-Z. This focuses on the back-end, and not on the front-end, so it uses a pre-made bootstrap template. I am 14 years old and I'm fairly proud of myself. I'd love to know what you guys think, and how I did on this project.

This is just a pet project that I created in 15 days, I believe and hope that there's a lot more to come.

Here it is:

GitHub logo ethanzrd / restful-blog

A blog-like website template created with Flask.

restful-blog

restful-blog

Features:

  • Configure your website effortlessly. Administrators will be able to configure the primary elements blog ranging from general website configuration to the blog's API configuration, without code whatsoever.

  • Social Icon Configuration. Administrators can configure the social icons at the website configuration setting, and choose which ones will be displayed with the appropriate links. Available social icons: Twitter, GitHub, Facebook, Instagram, YouTube, LinkedIn, Dev.

  • Registered users can comment on posts.

  • Manage your website staff by having the option to set users as administrators, and automatically notify them with an email that includes a new administrator report, which will be sent to both the website support email and the new administrator for the sake of logs.

  • Administrators can remove users (to remove other administrators you must be able to provide a valid authentication password), and provide a report as to why the user was deleted, and automatically notify the user.

  • Be…

Discussion (2)

Collapse
j_mplourde profile image
Jean-Michel Plourde • Edited on

I haven't jumped into the code yet, but I have an advice to give you on the README.md. The readme is the display window of your project and like a store it aims at selling your idea to potential customers/users.

Don't get me wrong, that's an amazing project packed with interesting features. A huge wall of text about all of them is a bit too much. What is currently in the readme is more suitable for the documentation of your project. You would really benefit from using this template format so you are sure to display everything there is to know about your project so user can quickly jump in to use or contribute to your project. There is also an awesome list of README to get inspired from.

Otherwise it's really impressive that you tackled this kind of project. You'll have a promising career. Happy coding!

Collapse
ethan_ profile image
Ethan Zerad Author

I'm really glad you took the time to write this, I never looked at it that way. I highly appreciate your advice and will surely follow it! Again, thank you.