Skip to content

Commit 2139516

Browse files
committed
feat(documentation): update the documentation on the readme file
- update the README.md file with information on how to setup the app - add a pull request template
1 parent 03790c3 commit 2139516

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#### What does this PR do?
2+
3+
#### Description of Task to be completed?
4+
5+
#### How should this be manually tested?
6+
7+
#### Any background context you want to provide?
8+
9+
#### What are the relevant pivotal tracker stories?
10+
11+
#### Screenshots (if appropriate)
12+
13+
#### Questions:

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
# DevopsDemo
22
Simple scripts to deploy a react project to an AWS instance
3+
4+
## How to deploy
5+
* Create an AWS free tier account
6+
* Create an AWS instance using the free tier resources and download your keypair file
7+
* SSH into the AWS instance you created and clone this repository in the root directory
8+
* Copy your keypair file into the root directory of the repository
9+
* Get a domain name (you can get a free one from www.freenom.com)
10+
* Using the .env.sample file, specify your environment variables in a .env file - make sure to include your domain name and react app repository
11+
* Reserve an elastic ip address on AWS
12+
* Configure route 53 using your domain name and the IP address you reserved
13+
* On your domain name accout, configure your DNS setting with the dns addresses provided by route 53
14+
* Switch to the root directory of the project and run the following command: "bash main.sh"
15+
* On your browser, type your domain name to access your app
16+

0 commit comments

Comments
 (0)