https://github.com/lauracole1900/reactemployeedirectory

React-based employee directory
https://github.com/lauracole1900/reactemployeedirectory

directory employees node node-js nodejs react reactjs

Last synced: 8 months ago
JSON representation

React-based employee directory

• Host: GitHub
• URL: https://github.com/lauracole1900/reactemployeedirectory
• Owner: LauraCole1900
• License: mit
• Created: 2020-11-18T20:18:06.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-11-10T05:21:47.000Z (almost 4 years ago)
• Last Synced: 2024-12-27T05:42:21.565Z (10 months ago)
• Topics: directory, employees, node, node-js, nodejs, react, reactjs
• Language: JavaScript
• Homepage: https://lauracole1900.github.io/reactEmployeeDirectory/
• Size: 1.22 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# React Employee Directory

## Table of Contents

* [Description](#description)

* [Links](#links)

* [Screenshots](#screenshots)

* [Installation Instructions](#installation-instructions)

* [Usage](#usage)

* [Technologies Used](#technologies-used)

* [Tests](#tests)

* [Credits](#credits)

* [Contributing](#contributing)

* [Questions](#questions)

* [Badges](#badges)

## Description

This application uses React to generate and manipulate a table of employee information. The user can click on any column header to sort the table by that column, or type into the input box to search for an employee by last name. Reloading the page following a name search will reset the table to show all employees.

## Links

[Deployed application on GitHub Pages](https://lauracole1900.github.io/reactEmployeeDirectory/)

## Screenshots

Directory with default sort (by employee ID):

![Default sort screencap:](src/assets/default-sort-screencap.png)

Directory sorted by department:

![Department sort screencap](src/assets/department-sort-screencap.png)

Searching by last name:

![Search results on last name](src/assets/search-by-last-name.png)

## Installation Instructions

If you want to run a copy of this app on your local machine, first clone the repository:

HTTPS:

```

$ git clone https://github.com/LauraCole1900/reactEmployeeDirectory.git

```

SSH:

```

$ git clone git@github.com:LauraCole1900/reactEmployeeDirectory.git

```

Then cd/ into the cloned directory and download the dependencies by typing into the command line

```

$ npm install --save

```

Once the dependencies are installed, start the application by typing into the command line

```

$ npm start

```

## Usage

This project is intended to be used to find employees in a directory.

## Technologies Used

[![Node.js](https://img.shields.io/badge/built%20with-Node.js-3c873a)](https://nodejs.org/en/) [![React](https://img.shields.io/badge/built%20with-React-61dbfb)](https://reactjs.org/)

## Tests

npm run test

## Credits

N/A

## Contributing

We believe code is never finished, welcome your contributions to enhance the applications functionality. Please adhere to the Code of Conduct for the Contributor Covenant, version 2.0, at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

## Questions

If you have further questions, you can reach me at lauracole1900@comcast.net. For more of my work, see [my GitHub](https://github.com/LauraCole1900).

## Badges

[![License badge](https://img.shields.io/badge/license-MIT-00008b)](.LICENSE) [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/LauraCole1900/reactEmployeeDirectory)