Introduction to Flask and Flask-SQLAlchemy #167
Conversation
This is the introduction to Flask, specifically including the usage of Flask-SQLAlchemy as the database solution. This is the first draft, as it will be reviewed by other group members and changes will be made to improve it.
|
Good job with the overview you gave on Flask-SQLAlchemy as the database solution, seems very thorough! I suggest however that you maybe include some videos in addition to the documentation linked, maybe can be an overview video on this tool or maybe even a video similar to this can work https://youtu.be/uZnp21fu8TQ?si=c46Sk4QzZCIMn9Lf |
Added more to additional resources including a link to an overview of the Flask-SQLAlchemy documentation, as well as a useful video for getting started with Flask-SQLAlchemy.
|
That's a great idea. This video seemed really useful for getting into Flask-SQLAlchemy, so I went ahead and added it to the Additional Resources section. I also added a link to more documentation in that section as well. |
|
Overall it looks really nice, just to improve visibility can you use markdown formatting to bold certain key points, can you also use ordering for your steps to setup and make the links look nicer by clicking a word instead of the link directly |
Reformatted the document by making links clickable words to make it cleaner, as well as numbering each section to improve the flow. This should make it easier to read and follow.
|
I made the changes, and I think this helps improve the readability of the document. I was wondering though, do you think I should add some more about what to do if the user is getting trouble with Flask? |
|
Yes, I think that would be really helpful. Maybe you can include some helpful documentation for common errors and how to troubleshoot them. |
In the additional resources section, I included documentation about troubleshooting some common problems that users run into while using Flask.
|
Your guide looks great! I was thinking that you could include the terminal commands to install flask and flask-sqlalchemy inside of the report itself (even though you've already linked the guides) to make it easy to copy and paste. |
Included summary of installation steps within the document for quick and easy reference for the user.
|
That's a good idea. I just made the changes, and I agree that this will make it easy for the reader to find and reference the installation commands. |
This is the introduction to Flask, specifically including the usage of Flask-SQLAlchemy as the database solution. This is the first draft, as it will be reviewed by other group members and changes will be made to improve it. The aim is to explain what each technology is and its benefits, then explain the installation, and finally give some insight on how to use these technologies.