Hacker News Clone

In an effort to learn to react here is a react based hacker news clone from scratch using the official open Hacker News's Algolia API https://hn.algolia.com/api

Live Demo

Featuring

• React - UI Framework
• React Hook - A way to use state and side-effects in React function components
• Axios - A http client
• Server Side Rendering
• Express Server
• Rechats - A composable charting library built on React components
• Docker Containership
• Jest & Enzyme - Testing Framework
• Firebase - Deployment

Installing

This project was bootstrapped with Create React App. Use the node package manager npm to set up the development enviroment.

1. Clone the repository using :

git clone https://github.com/sk0693/hn-clone.git

2. Change the repository directory :

cd hn-clone

3. Install the needed node packges/modules :

npm install

4. Start the development server :

npm start

Available Scripts

In the project directory, you can run:

dev

$ npm run dev Runs to build the React components and the express server. And after building the code it will run the App on PORT.

dev:build-server

$ npm run dev:build-server Runs the development server using webpack-cli for Server side rendering and using this the React Hydrate the components.

both

$ npm run both It will run the express server and the React server parallely using npm-run-all

docker:build

$ npm run docker:build Will build the container and downloads all modules/packages which is required for the app in its own container.

docker:up

$ npm run docker:up This command will run the already buit image and runs our app. If the build is not made then it will made it first and then runs the App in own container.

firebase:deploy

$ npm run firebase:deploy Will deployed the built to the Firebase server.

firebase

$ npm run firebase It will first made the build of the project and the deployed it to the Firebase server.

Running the tests

Create React App uses Jest as its test runner. Jest ensuring your tests have unique global state, Jest can reliably run tests in parallel. To make things quick, Jest runs previously failed tests first and re-organizes runs based on how long test files take.

Enzyme is a JavaScript Testing utility for React that makes it easier to assert, manipulate, and traverse your React Components' output. Enzyme, created by Airbnb, adds some great additional utility methods for rendering a component (or multiple components), finding elements, and interacting with elements.

Writing Tests

To create tests, add it() (or test()) blocks with the name of the test and its code. You may optionally wrap them in describe() blocks for logical grouping but this is neither required nor recommended.

Jest provides a built-in expect() global function for making assertions. A basic test could look like this:

I have made test case in AppOnLoadTestingWithMinimulData.test file so using the test command the jest framework automatically excute the all .test extension files sequentially.

import React from 'react'
import { shallow } from 'enzyme'
import { configure } from 'enzyme';
import toJson from 'enzyme-to-json'
import Adapter from 'enzyme-adapter-react-16';
import App from '../src/App'

describe('App', () => {
    it('renders without crashing given the required props', () => {
        const props = {
            hits: [
                {
                    created_at: "2018-03-14T03:50:30.000Z",
                    title: "Stephen Hawking has died",
                    url: "http://www.bbc.com/news/uk-43396008",
                    author: "Cogito",
                    points: 6015,
                    story_text: null,
                    comment_text: null,
                    num_comments: 436,
                    story_id: null,
                    story_title: null,
                    story_url: null,
                    parent_id: null,
                    created_at_i: 1520999430,
                    relevancy_score: 8012,
                    objectID: "16582136",
                }
            ]
        }
        const wrapper = shallow(<App {...props} />)
        expect(toJson(wrapper)).toMatchSnapshot()
    })
})

To execute this just run:

npm test or npm run test

In this test case I have used dummy data for automate the test case. It has to be rendered without getting crashed with the data as props. And then the app will rendered the data accordingly.

The output of this test case would be.

Author

• Sourabh Khurana

• GitHub
• LinkedIn
• Portfolio