From 7393b191a295cf4b0e0ba5b5690b2e12b66ef79e Mon Sep 17 00:00:00 2001
From: Jibril Tapiador <tapiador@jibril.ch>
Date: Mon, 29 Aug 2022 23:55:45 +0800
Subject: [PATCH 1/2] readme draft update

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 49 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 5be19d6d..a124c4b5 100644
--- a/README.md
+++ b/README.md
@@ -28,15 +28,55 @@ There are many showcase/example React projects out there but most of them are wa
 - Client written in Babel powered JavaScript
 - API written in TypeScript and using TypeORM
 
-## Setting up development environment 🛠
-
-- Install [postgreSQL](https://www.postgresql.org/) if you don't have it already and create a database named `jira_development`.
-- `git clone https://github.com/oldboyxx/jira_clone.git`
-- Create an empty `.env` file in `/api`, copy `/api/.env.example` contents into it, and fill in your database username and password.
-- `npm run install-dependencies`
-- `cd api && npm start`
-- `cd client && npm start` in another terminal tab
-- App should now be running on `http://localhost:8080/`
+## Getting Started 🛠
+
+Make sure you have [Node.js](https://nodejs.org/en/) and [PostgreSQL](https://www.postgresql.org/download/) installed.
+
+1. [Enter your postgres terminal](https://replayable.io/replay/630b672f544b16006844e59a/?share=EtpMi7WDrbi8ly18WObRQQ) and create a database named `jira_development`.
+
+```sql
+CREATE DATABASE jira_development;
+```
+
+2. Clone this repository and enter the project directory.
+
+```bash
+git clone git@github.com:oldboyxx/jira_clone.git
+cd jira_clone
+```
+
+3. The API uses environmental variables. Make sure to create an `.env` file in `/api` and use our sample `/api/.env.example` as a baseline.
+
+```bash
+cp api/.env.example api/.env
+```
+
+4. Don't forget to fill in your database username and password in the `api/.env` file. It should be the same user that created the database from step 1.
+
+```
+DB_USERNAME=postgres
+DB_PASSWORD=
+```
+
+5. Install Node dependencies
+
+```bash
+npm run install-dependencies
+```
+
+6. Start the API server.
+
+```bash
+cd api && npm start
+```
+
+7. From another terminal, start the front end.
+
+```bash
+cd client && npm start
+```
+
+The app should now be running on `http://localhost:8080/`.
 
 ## Running cypress end-to-end tests 🚥
 

From 4ff037a529205ed6d0d10a3c4c6e72dc06df7b6f Mon Sep 17 00:00:00 2001
From: Jibril Tapiador <tapiador@jibril.ch>
Date: Sun, 4 Sep 2022 07:16:04 +0800
Subject: [PATCH 2/2] updates README.md

---
 README.md | 48 ++++++++++++++++++++++++------------------------
 1 file changed, 24 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index a124c4b5..62554a6b 100644
--- a/README.md
+++ b/README.md
@@ -34,49 +34,49 @@ Make sure you have [Node.js](https://nodejs.org/en/) and [PostgreSQL](https://ww
 
 1. [Enter your postgres terminal](https://replayable.io/replay/630b672f544b16006844e59a/?share=EtpMi7WDrbi8ly18WObRQQ) and create a database named `jira_development`.
 
-```sql
-CREATE DATABASE jira_development;
-```
+   ```sql
+   CREATE DATABASE jira_development;
+   ```
 
 2. Clone this repository and enter the project directory.
 
-```bash
-git clone git@github.com:oldboyxx/jira_clone.git
-cd jira_clone
-```
+   ```bash
+   git clone git@github.com:oldboyxx/jira_clone.git
+   cd jira_clone
+   ```
 
 3. The API uses environmental variables. Make sure to create an `.env` file in `/api` and use our sample `/api/.env.example` as a baseline.
 
-```bash
-cp api/.env.example api/.env
-```
+   ```bash
+   cp api/.env.example api/.env
+   ```
 
 4. Don't forget to fill in your database username and password in the `api/.env` file. It should be the same user that created the database from step 1.
 
-```
-DB_USERNAME=postgres
-DB_PASSWORD=
-```
+   ```
+   DB_USERNAME=postgres
+   DB_PASSWORD=
+   ```
 
 5. Install Node dependencies
 
-```bash
-npm run install-dependencies
-```
+   ```bash
+   npm run install-dependencies
+   ```
 
 6. Start the API server.
 
-```bash
-cd api && npm start
-```
+   ```bash
+   cd api && npm start
+   ```
 
 7. From another terminal, start the front end.
 
-```bash
-cd client && npm start
-```
+   ```bash
+   cd client && npm start
+   ```
 
-The app should now be running on `http://localhost:8080/`.
+   The app should now be running on `http://localhost:8080/`.
 
 ## Running cypress end-to-end tests 🚥