diff --git a/README.md b/README.md index 34f1d93..e24b7af 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,49 @@ -# The Anti-Social Network +## the anti-social network -Join at [https://anti-social.herokuapp.com](https://anti-social.herokuapp.com) !!! +
-### Are you tired of not having enough online followers in your social networks? +

+ + + + + + +

-Can't you stand the fact that only the cool kids are popular and have all the "likes"? Nobody "stars" or "retweets" your stories? Do you wish you had more friends to love all your pointless posts? +
-### Your problems are over! +--- -Get as many friends as you need to feel good about yourself again! Register Today! +### running +
-### Posts are not limited to 140 characters and you can write in rich text! - - -### Screenshots: - -![](http://i.imgur.com/aWITmEH.png) - -![](http://i.imgur.com/fRnw4Ok.png) - -![](http://i.imgur.com/N9e8kTB.png) - -![](http://i.imgur.com/M9WeNOs.png) - -![](http://i.imgur.com/GM6WNIK.png) - -![](http://i.imgur.com/8ugLkBq.png) - - - - - -## Instructions - Development - -The Anti-Social Network was built on Flask&Python. The License is MIT, feel free to play: - - -#### Start your virtual environment. - -#### Import the dependences: - -``` -(anti) $ pip install -r requirements/* -``` - -####Import environment variables for user authentications (this can also be added to your .bash): +* install the dependencies in a venv: ``` -(anti) $ export MAIL_USERNAME= -(anti) $ export MAIL_PASSWORD= -(anti) $ export ANTISOCIAL_ADMIN= -(anti) $ export SECRET_KEY= +pip install -r requirements/* ``` - -#### Upgrade your DB: +* import environment variables for user authentications (this can also be added to your `.bash`): ``` -$ python manage.py db migrate -$ python manage.py db upgrade +export MAIL_USERNAME= +export MAIL_PASSWORD= +export ANTISOCIAL_ADMIN= +export SECRET_KEY= ``` -#### Run! +* upgrade your DB: ``` -$ python manage.py runserver +python manage.py db migrate +python manage.py db upgrade ``` -#### You can also do: +* run: ``` -$ python manage.py shell -$ python manage.py test +python manage.py runserver ``` - - - -## Instructions - Production - -If you want to use the machinery to deploy the app somewhere (MIT License). -[Instructions here](https://coderwall.com/p/pstm1w?i=2&p=1&q=author%3Abt3gl&t%5B%5D=bt3gl). - - - ----- - - -## License - -When making a reference to my work, please use my [website](http://bt3gl.github.io/index.html). -This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).