Skip to content

Commit 319dfad

Browse files
committed
Final-ish read me
1 parent 0aaa35f commit 319dfad

File tree

1 file changed

+38
-7
lines changed

1 file changed

+38
-7
lines changed

README.md

+38-7
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,41 @@
1313
<br>
1414
</p>
1515
<img src="./images/diagram1.jpg">
16-
<h4>
17-
Getting Snap running locally
18-
</h4>
19-
<p>
20-
21-
</p>
22-
</div>
16+
</div>
17+
18+
#### Getting Snap running locally
19+
20+
###### Requirements
21+
Vyper Requirements
22+
Pre requisite: [python3](https://www.python.org/download/releases/3.0/)
23+
1. Set up a virtual environment
24+
```
25+
$ pip3 install virtualenv
26+
$ virtualenv -p python3 env
27+
$ source env/bin/activate
28+
```
29+
2. Install dependencies
30+
```
31+
pip install -r requirements.txt
32+
```
33+
Pre requisite: [truffle](https://truffleframework.com/)
34+
Pre requisite: [ganache](https://truffleframework.com/ganache)
35+
Pre requisite: [yarn](https://yarnpkg.com/lang/en/docs/install/#windows-stable)
36+
3. Run yarn
37+
```
38+
yarn
39+
```
40+
###### Testing
41+
To test the contracts, run:
42+
```
43+
truffle test --migrations_directory migrations_null
44+
```
45+
To get the front end running locally, run:
46+
```
47+
yarn serv
48+
```
49+
50+
Have a balanced time!
51+
<div align="center">
52+
<img src="./images/gif.gif">
53+
</div>

0 commit comments

Comments
 (0)