Lerking/news-demo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ayooluwa Isaiah
2020-11-22 19:52:53 +01:00
parent 843a1394d8
commit fa04918530
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -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.