githubmirror/flask

examples/minitwit/README

38 строк834 B

Hopsken

Update README for minitwit (#2119)

21 дек 2016, 23:07

21 дек 2016, 23:077f28837


                        / 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.