Giter VIP home page Giter VIP logo

hibp-client's Introduction

hibp-client

This React/Redux/NodeJS/Express client application for the Have I been Pwned API.

Setup

Prequisities

  • Node 10.15.0 (Tested)
  • Yarn

Install Dependencies

yarn

Start Development Environment

yarn run watch

Open http://localhost:4000 in a web browser to view the application.

Start Development Environment with Hot loading React App

yarn run watch:hot

Open http://localhost:3000 in a web browser to view the application.

Building the React App

yarn run build:react

Starting the application

yarn run start

Open http://localhost:4000 in a web browser to view the application.

Please note that you should build the React before starting the Node server.

Test Suite

Running the test suite:

yarn run test

You can also run the test suite with a watch running:

yarn run test:watch

The unit test suite coverage is currently incomplete with the current code in /test directory. It was intended to cover the server side code, Redux reducers and React components with a test driven development approach. Sadly this was dropped due to time constraints with only the Basic view (http://localhost:4000/test) having reducer and component coverage. However the HIBP API client classes have test coverage.

ToDos

  • Restyle UI elements more extensively
  • Delint codebase - unfortunately automatic linting was not running in the editor used for development. A linting profile and script exist however this process has not been completed due to lack of time for retesting the resulting refactored code.
  • Implement unit testing for all Redux Reducers and React Components
  • Add registration page
  • Add Login page
  • Add password reset page
  • Session management using express-session - This would include persisting the user's last search term to allow for rexecution of searches upon refreshing the page.
  • Authentication using simple custom class backed by a LowDB database.

hibp-client's People

Contributors

courtneydl avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.