Skip to content

Commit

Permalink
Merge pull request adeyosemanputra#92 from DigvijayBhosale1729/docs
Browse files Browse the repository at this point in the history
Updated Readme.md installation instructions and added new installation video
  • Loading branch information
adeyosemanputra authored Mar 9, 2022
2 parents 41eb852 + ce516ec commit c2b2b9f
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,33 +31,49 @@ Table of Contents
## Installation

### From Sources

To setup the project on your local machine:
<br>
1. Clone the repository using GitHub website or git in Terminal

First, Clone the repository using GitHub website or git in Terminal
```
git clone https://github.com/adeyosemanputra/pygoat.git
### To Download a specific branch
git clone -b <branch_name> https://github.com/adeyosemanputra/pygoat.git
```

2. Install the requirements `pip install -r requirements.txt`.<br>
3. Change directory to the the Django Project directory `cd pygoat`<br>
4. Apply the migrations `python3 manage.py migrate`.<br>
5. Finally, run the development server `python3 manage.py runserver`.<br>
6. The project will be available at <http://127.0.0.1:8000>
#### Method 1

1. Install all app and python requirements using installer file - `bash installer.sh`
2. Change directory to the the Django Project directory `cd pygoat`<br>
3. Apply the migrations `python3 manage.py migrate`.<br>
4. Finally, run the development server `python3 manage.py runserver`.<br>
5. The project will be available at <http://127.0.0.1:8000>

#### Method 2

1. Install python3 requirements `pip install -r requirements.txt`.<br>
2. Change directory to the the Django Project directory `cd pygoat`<br>
3. Apply the migrations `python3 manage.py migrate`.<br>
4. Finally, run the development server `python3 manage.py runserver`.<br>
5. The project will be available at <http://127.0.0.1:8000>

### Docker Container
1. Install [Docker](https://www.docker.com)
2. Run `docker pull pygoat/pygoat`
3. Run `docker run --rm -p 8000:8000 pygoat/pygoat` or `docker run pygoat/pygoat`
4. Browse to <http://127.0.0.1:8000>

### Installation Video
[![](http://img.youtube.com/vi/rfzQiMeiwso/0.jpg)](http://www.youtube.com/watch?v=rfzQiMeiwso "Installation Pygoat")
### Installation video

1. From Source using `installer.sh`
- [Installing PyGoat from Source](https://youtu.be/IkazbGlkoOE)
2. Without using `installer.sh`
- [![](http://img.youtube.com/vi/rfzQiMeiwso/0.jpg)](http://www.youtube.com/watch?v=rfzQiMeiwso "Installation Pygoat")


## Solutions
<a href="/pygoat/Solutions/solution.md">Solutions to all challenges</a> •
</p>
<a href="/pygoat/Solutions/solution.md">Solutions to all challenges</a>

## Live Demo
http://pygoat-web.herokuapp.com <br>
Expand Down

0 comments on commit c2b2b9f

Please sign in to comment.