README

                        / MiniTwit /

           because writing todo lists is not fun


    ~ What is MiniTwit?

      A SQLite and Flask powered twitter clone

    ~ How do I use it?

      1. install flask and flask-cli via pip

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

      3. fire up a shell and run this:

         export FLASK_APP=minitwit.py; \
         export LC_ALL=en_US.utf-8; \
         export LANG=en_US.utf-8; \
         flask initdb

      4. now you can run minitwit:

         export FLASK_APP=minitwit.py; \
         export LC_ALL=en_US.utf-8; \
         export LANG=en_US.utf-8; \
         flask run --host=0.0.0.0 --with-threads --no-debugger --no-reload

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

    ~ Is it tested?

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