mjsouthcott / 19-user-directory

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

User Directory

GitHub followers GitHub repo size GitHub top language GitHub last commit

Table of Contents

Description

This is a responsive web application that allows users to view a user directory containing employment information, and sort and filter the results.

Technologies Used

  • HTML5
  • CSS3
  • Javascript
  • Node.js
  • React
  • Bootstrap
  • Various npm packages

User Story

AS A user
I WANT to be able to view my entire employee directory at once
SO THAT I have quick access to their information.

Installation

To install the application, click "Clone or download", copy the URL, launch Git Bash, navigate to your desired directory and use

git clone

followed by the copied URL.

To launch the deployed application, click the following link: https://mjsouthcott.github.io/19-user-directory/.

Step 1

The default view will show all users in the directory sorted in ascending order by ID.

Step 2

To sort the results in a different order, select a column to sort by, and ascending or descending order from the dropdowns on the left, and click the "Sort" button. In this case, the results are sorted by last name in descending order.

Step 3

To filter the results, select a column to filter by from the dropdown and enter a value in the input on the right, and click the "Filter" button. In this case, the results are filtered by rank for "Craftsman".

Usage

Launch Git Bash and navigate to the application's root directory. Once there, use

npm i

to install the dependencies, followed by

npm start

to run the application. If it doesn't do it automatically, open a browser window and go to

https://localhost:3000

Licence

MIT License

Copyright (c) 2020 Matthew James Southcott

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

Feel free to email me if you'd like to contribute.

About


Languages

Language:JavaScript 80.6%Language:HTML 11.4%Language:CSS 8.0%