Skip to content
This repository was archived by the owner on Oct 26, 2024. It is now read-only.

Commit f3faa95

Browse files
Clean up readme
1 parent 482bdea commit f3faa95

1 file changed

Lines changed: 26 additions & 71 deletions

File tree

README.md

Lines changed: 26 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,49 @@
1-
# The Anti-Social Network
1+
## the anti-social network
22

3-
Join at [https://anti-social.herokuapp.com](https://anti-social.herokuapp.com) !!!
3+
<br>
44

5-
### Are you tired of not having enough online followers in your social networks?
5+
<p align="center">
6+
<img height="200" src="http://i.imgur.com/aWITmEH.png">
7+
<img height="200" src="http://i.imgur.com/fRnw4Ok.png">
8+
<img height="200" src="http://i.imgur.com/N9e8kTB.png">
9+
<img height="200" src="http://i.imgur.com/M9WeNOs.png">
10+
<img height="200" src="http://i.imgur.com/GM6WNIK.png">
11+
<img height="200" src="http://i.imgur.com/8ugLkBq.png">
12+
</p>
613

7-
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?
14+
<br>
815

9-
### Your problems are over!
16+
---
1017

11-
Get as many friends as you need to feel good about yourself again! Register Today!
18+
### running
1219

20+
<br>
1321

14-
### Posts are not limited to 140 characters and you can write in rich text!
15-
16-
17-
### Screenshots:
18-
19-
![](http://i.imgur.com/aWITmEH.png)
20-
21-
![](http://i.imgur.com/fRnw4Ok.png)
22-
23-
![](http://i.imgur.com/N9e8kTB.png)
24-
25-
![](http://i.imgur.com/M9WeNOs.png)
26-
27-
![](http://i.imgur.com/GM6WNIK.png)
28-
29-
![](http://i.imgur.com/8ugLkBq.png)
30-
31-
32-
33-
34-
35-
## Instructions - Development
36-
37-
The Anti-Social Network was built on Flask&Python. The License is MIT, feel free to play:
38-
39-
40-
#### Start your virtual environment.
41-
42-
#### Import the dependences:
43-
44-
```
45-
(anti) $ pip install -r requirements/*
46-
```
47-
48-
####Import environment variables for user authentications (this can also be added to your .bash):
22+
* install the dependencies in a venv:
4923

5024
```
51-
(anti) $ export MAIL_USERNAME=<Gmail username>
52-
(anti) $ export MAIL_PASSWORD=<Gmail password>
53-
(anti) $ export ANTISOCIAL_ADMIN=<your-email-address>
54-
(anti) $ export SECRET_KEY=<choose-a-secrecy>
25+
pip install -r requirements/*
5526
```
5627

57-
58-
#### Upgrade your DB:
28+
* import environment variables for user authentications (this can also be added to your `.bash`):
5929

6030
```
61-
$ python manage.py db migrate
62-
$ python manage.py db upgrade
31+
export MAIL_USERNAME=<Gmail username>
32+
export MAIL_PASSWORD=<Gmail password>
33+
export ANTISOCIAL_ADMIN=<your-email-address>
34+
export SECRET_KEY=<choose-a-secrecy>
6335
```
6436

65-
#### Run!
37+
* upgrade your DB:
6638

6739
```
68-
$ python manage.py runserver
40+
python manage.py db migrate
41+
python manage.py db upgrade
6942
```
7043

71-
#### You can also do:
44+
* run:
7245

7346
```
74-
$ python manage.py shell
75-
$ python manage.py test
47+
python manage.py runserver
7648
```
7749

78-
79-
80-
81-
## Instructions - Production
82-
83-
If you want to use the machinery to deploy the app somewhere (MIT License).
84-
[Instructions here](https://coderwall.com/p/pstm1w?i=2&p=1&q=author%3Abt3gl&t%5B%5D=bt3gl).
85-
86-
87-
88-
----
89-
90-
91-
## License
92-
93-
When making a reference to my work, please use my [website](http://bt3gl.github.io/index.html).
94-
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).

0 commit comments

Comments
 (0)