bundled/flask/examples/minitwit/README @ 87fcb432d230

Merged in kberridge/hg-review (pull request #6)

web: display branch name on index if other than 'default'
author Christophe de Vienne <cdevienne@gmail.com>
date Fri, 21 Nov 2014 18:38:48 +0100
parents f33efe14bff1
children (none)

                        / 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. fire up a python shell and run this:

         >>> from minitwit import init_db; init_db()

      3. now you can run the minitwit.py file with your
         python interpreter and the application will
         greet you on http://localhost:5000/
	
    ~ Is it tested?

      You betcha.  Run the `minitwit_tests.py` file to
      see the tests pass.