Skip to content

Commit 4102315

Browse files
committed
add README.md
1 parent 43a9a33 commit 4102315

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# EaseFinance
2+
Stock-trading website [Live Version](https://ease-finance.herokuapp.com)
3+
4+
EA$E Finance, a web app which you can manage portfolios of stocks. Not only will this tool allow you to check real stocks' actual prices and portfolios' values, it will also let you buy (okay, "buy") and sell (okay, "sell") stocks by querying IEX for stocks' prices.
5+
6+
## Get Started
7+
8+
Click on this [link](https://ease-finance.herokuapp.com) to see the website **or** you can download or clone the project.
9+
10+
## TECHNOLOGY USED
11+
12+
* HTML & CSS
13+
* Python
14+
* Flask
15+
* Bootstrap
16+
* [IEX trading](https://iextrading.com)
17+
* SQLite
18+
* Postgresql database
19+
* [Memegen](https://memegen.link)
20+
21+
## How to install on your server
22+
23+
* You can download the zip or clone the project with git.
24+
25+
`https://github.com/abdsamadf/similarities.git`
26+
27+
* Install `requirement.txt` via terminal:
28+
29+
`pip install -r /path/to/requirements.txt`
30+
31+
## Running the site
32+
33+
* To enable all development features (including debug mode) you can export the FLASK_ENV environment variable and set it to development before running the server:
34+
35+
`export FLASK_ENV=development`
36+
37+
* To run the application you can use the **flask** command or python’s -m switch with Flask. Before you can do that you need to tell your terminal the application to work with by exporting the **FLASK_APP** environment variable:
38+
39+
`export FLASK_APP=application.py`
40+
41+
* To test the web app, execute
42+
43+
``` Shell
44+
$ flask run
45+
* Running on http://127.0.0.1:5000/
46+
```
47+
48+
* Alternatively you can use python -m flask:
49+
``` Shell
50+
$ python -m flask run
51+
* Running on http://127.0.0.1:5000/
52+
```
53+
54+
## Requirements
55+
56+
* Python
57+
* Flask

0 commit comments

Comments
 (0)