flask/examples/minitwit
Hopsken 755401d5dc Update README for minitwit (#2119)
add step 2 to run minitwit
2016-12-21 21:07:09 +01:00
..
minitwit
tests
.gitignore
MANIFEST.in
README Update README for minitwit (#2119) 2016-12-21 21:07:09 +01:00
setup.cfg
setup.py

                        / MiniTwit /

           because writing todo lists is not fun


    ~ What is MiniTwit?

      A SQLite and Flask powered twitter clone

    ~ How do I use it?

      1. edit the configuration in the minitwit.py file or
         export an MINITWIT_SETTINGS environment variable
         pointing to a configuration file.

      2. install the app from the root of the project directory

         pip install --editable .

      3. tell flask about the right application:

         export FLASK_APP=minitwit

      4. fire up a shell and run this:

         flask initdb

      5. now you can run minitwit:

         flask run

         the application will greet you on
         http://localhost:5000/

    ~ Is it tested?

      You betcha.  Run the `python setup.py test` file to
      see the tests pass.