Northcoders News - Frontend Project

Welcome to Northcoders News!

Please note this was part of a coding bootcamp, I have not worked on the code since Oct 2018 and will instead leave it as it was when I was learning so that I can show progression in how far I have come since starting to code

A React app, similar to Reddit.

Northcoders News is a news aggregator which has articles divided by topic; each article has comments which can be added to or deleted by the user who posts them and votes which can be incrememented or decremented.

The Front End app has been deployed by Netlify and can be found at https://5bddfc143813f064068a9638--nc-news-frontend.netlify.com/ (Best viewed in Chrome)

The API has been deployed by Heroku and can be found at https://nc-news33.herokuapp.com/

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

There are a few things you will need in order to install the App, these are listed below.

General:

A text editor e.g. VS Code, Sublime, Atom etc
A Linux terminal e.g. Terminator
npm package manager (comes with node.js) Installation instructions

Dependencies you will need:

Reach/Router v1.2.1 Installation Instructions
axios v0.18.0 Installation Instructions
React v16.5.2 Information

Installing

A step by step series of examples that tell you how to get a development env running

Get this Repository

Fork this repository and clone it so you have your own local copy
cd into the folder you want to save the copy to e.g. cd Documents/myprojects and run the git clone command in your terminal

$ git clone https://github.com/HorrorOfPartyBeach/Northcoders-News-FE.git

Run cd Northcoders-News-FE and then npm install

Start & watch

Run npm start

This runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

Deployment

The Front end App has been deployed by Netlify and can be found at https://5bc9c9b182d3f1791ea834c3--nc-news-frontend.netlify.com/

The back end API has been deployed by Heroku and can be found at https://nc-news33.herokuapp.com/

Built With

React - JS library for building user interfaces
Netlify - For deploying apps

Authors

Emma Gilmour - HorrorOfPartyBeach

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

The great tutors and course at Northcoders
A myriad of documentation

HorrorOfPartyBeach / Northcoders-News-FE