GET YOUR NC NEWS

Get Your NC News is a front end user webview built using the NC News backend api.

All relevant links are listed below:

Front-end:
Hosted version GitHub repository

Back-end:
Hosted version GitHub repository

Getting Started

The following steps outline how to get the front-end repository running on your local machine for visual purposes, as well as providing a general guideline for live deployment.

1 - Clone the repository

From your terminal, clone the repository to your desired folder

# git clone https://github.com/Soupcodes/Get-Your-NC-News.git

# cd Get-Your-NC-News

2 - Setting up your environment and prerequisites

Once in your editor, the dependencies required for testing and deployment are listed in the package.json file.

Run the following command in your CLI to install all dependencies needed to run and deploy the site:

# npm i

Minimum version are:

"dependencies": {
  "@reach/router": "^1.2.1",
  "axios": "^0.19.0",
  "g": "^2.0.1",
  "netlify-cli": "^2.12.0",
  "react": "^16.8.6",
  "react-dom": "^16.8.6",
  "react-loader-spinner": "^3.1.2",
  "react-scripts": "3.0.1"
},

3 - Run locally

With all dependencies installed, you can run npm start in the terminal to see a locally hosted version of the site.

4 - Useful docs

Should you run into any issues utilising pre-requisite dependencies, or deployment, the official documentation provides useful insight as a guideline as well as for troubleshooting purposes. See below.

react

@reach/router

axios

netlify-cli

Author: Alan Tong