From fa04918530254312724853c2c297dcf4642db28f Mon Sep 17 00:00:00 2001 From: Ayooluwa Isaiah Date: Sun, 22 Nov 2020 19:52:53 +0100 Subject: [PATCH] Update README --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2a471eb..98dafbe 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,31 @@ -# News Demo Application +# News Application Demo -Learn web development with Go. Live demo: https://freshman-news.herokuapp.com/ +Learn how to develop web applications with Go by building a News application. -Here's what the completed application looks like: +Here's what the [completed application](https://freshman-news.herokuapp.com/) +looks like: -![demo](https://res.cloudinary.com/freshman/image/upload/v1566482694/Screenshot_from_2019-08-22_15-04-27.png) +![demo](https://ik.imagekit.io/freshman/news-demo_MrYio9GKlzSi.png) -The code in this repo is meant to be a reference point for anyone following along with the [tutorial](https://freshman.tech/web-development-with-go/). +The code in this repo is meant to be a reference point for anyone following +along with the [tutorial](https://freshman.tech/web-development-with-go/). ## Prerequisites -- You need to have Go installed on your computer. The version used for the tutorial is **1.15.3**. +- You need to have [Go](https://golang.org/dl/) installed on your computer. The +version used to test the code in this repository is **1.15.3**. -- Sign up for a [News API account](https://newsapi.org/register) and get your free API key. +- Sign up for a [News API account](https://newsapi.org/register) and get your +free API key. ## Get started - Clone this repository to your filesystem. + +```bash +$ git clone https://github.com/Freshman-tech/news-demo +``` + - Rename the `.env.example` file to `.env` and enter your News API Key. - `cd` into it and run the following command: `go build && ./news-demo` to start the server on port 3000. - Visit http://localhost:3000 in your browser.