diff --git a/README.md b/README.md index 98bd576..30cd0e8 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,28 @@ This is project is structured so that the developer can choose to set it up with
# **PROJECT SETUP** +## **Cloning Project** +Clone this repo and change directory into the project root folder by running the following commands: + +```bash +git clone https://github.com/KanaryStack/aliascheck.git +``` +>NOTE: +>If you have setup an SSH connection to this repo, you can run this command instead: +>```bash +>git clone git@github.com:KanaryStack/aliascheck.git +>``` + +and go to the project root folder like so: +```bash +cd aliascheck +``` +then switch to last stable branch with Flask backend: +```bash +git checkout 940bc4d36f8a34e65373e080024cf98d97b4cf52 +``` + +## **Starting Up the Project** ## **With Docker Compose** To start the project using Docker, even from scratch, run the following command: