React app for a website serving articles and comments.

• Getting Started
• — Installation
• Testing
• — Unit Testing
• — Integration Testing
• Deployment
• API
• Available Scripts
• Built With
• Authors

These instructions will get you a copy of the project running on your local machine. This is for testing and development only; for production see deployment

Clone this repository:

git clone https://github.com/Jakub-L/nc-news-frontend.git

Install the package dependencies:

npm install

Start the development server:

npm start

The website can now be reached at localhost on port 3000.

Unit testing is done via React's in-built Jest testing suite. In order to run the automated unit tests for utility functions, run the following command:

npm test

Integration and end-to-end testing is managed via Cypress. In order to run the tests, run the following command:

npm run cy:open

This will open Cypress and allow for running of the tests.

The app is hosted on Netlify.

The app uses a separate back-end to serve its data.

The repository is hosted on GitHub, and the live version is hosted on Heroku

• npm start - initialise the local development server,
• npm run build - build the app into the build folder,
• npm test - run the Jest test suite for unit testing,
• npm eject - remove single-build dependency from project,
• npm run cy:open - open cypress for end-to-end testing

• React: basic library,
• Axios: request library used for API calls,
• Reach Router: route management,
• Cypress: end-to-end testing,

• Jakub-L: Initial work