italomaia / flask-empty

An empty project skeleton / boilerplate for flask projects. Powered by CookieCutter.
667 stars 93 forks source link

How to make flask-empty better? #22

Open italomaia opened 6 years ago

italomaia commented 6 years ago

What is missing? What could be better?

flip111 commented 6 years ago

I'm new to python and flask. I figured i try this project.

First thing that was not clear is how to run the code python main.py did nothing. Found out i had to use python manage.py runserver.

Then i look in main.py and the controller code is there with a lot of other stuff like that i don't get. I like to just have 1 file where i can put my controller code without putting other stuff. It's not obvious which code i should be changing actually. Should all the routes be in that class App?

I also try python manage.py apps. What does this even do? It says "logger started" so i guess it's logger setup, "how will you call it?" call what? the log file? So i type app.log. Now i have a folder with ERASEME.txt in it ??

There is a file database.py fine .. but where do i store the models?

There is a file empty.py what does this even do? What blueprints? it's not in the readme

What are all the commands for in manage.py?

This package was too much cognitive overhead for me so i just start using flask with pip install flask and follow the flask documentation.

italomaia commented 6 years ago

It is expected of the user to know some "flask", but I get what you mean. Docs can certainly be improved. I'll try to improve the getting started.

phrohdoh commented 6 years ago

It may be helpful to include a README.md file in the root of generated project which details how to use manage.py to run, test, manage the db, etc. for the project.

italomaia commented 5 years ago

Thank you for the message, @Phrohdoh I went to write some extra docs (a simple readme), and noticed all commands are outdated (they use flask-script and not click). Time to hit two birds with one stone (and hurt no bird =D)

italomaia commented 5 years ago

@Phrohdoh let me know if the last update does the trick for you ; )