React Employee Directory

An employee directory application using React to create UI components, manage component state and respond to user input events.

Project Links

Repo Link
NOTE: The deployed app can be found on GitHub Pages. Please see the Getting Started section for more information regarding installation, usage, contribution guidelines and where to go for questions.

Table of Contents

1. About The Project
2. Project Links
3. Demo
4. Getting Started
5. Installation
6. Usage
7. Contribution Guidelines
8. Questions
9. Project Status
10. License

About The Project

The scope of this project was to create a resource for employees and managers to view non-sensitive data about other employees. It would be particularly helpful to be able to filter employees by name. This app utilizes Random User API to demonstrate its functionality.

When the app loads, a user can:

• Sort the rendered employee table by pressing the sort button to scroll through employees, or

• Filter employees by entering an employee name,

• Or, simply begin entering letters in an employee's name and results will begin to render in the table as the user types.

Demo

The following is an overview of the application in operation and rendering of the employee directory app.

The following is a screenshot of the application and overview of its functionality:

Getting Started

Technologies used in this project include:

• React
• Random User API
• Node
• Axios

Installation:

Clone Repository

• git clone https://github.com/onomatopoetica/react-employee-directory.git

Install Dependencies

• Ensure you have Node.js installed on your machine.

• npx create-react-app react-employee-directory to install React for the project.

• All NPM packages required for this application are already listed as dependencies in the package.json file. Run the command npm install command in your terminal at the root directory level to install the packages.

Start Application

• Once React and dependencies are installed, cd into your directory (if not already there) and run npm start to view the project on http://localhost:3000/.

Return to Table of Contents

Usage

• See About The Project or Demo video above for more information on how it works.
• View Project Links above for the link to the deployed app on Heroku.

Contribution Guidelines

• When contributing to this repository, please contact the project team for review of your contribution plan. See contact details below.

Questions

Connect With Me:

Onomatopoetica

Contact

[email protected]

Project Status

Current Project Activity

Active

Return to Table of Contents

License

Distributed under the MIT License. See LICENSE for more information.

This README was generated with ♥️  by Good README Generator.