davidsaulrodriguez/orgchart

An interactive Employee Directory that is populated with the Random User Generator from https://randomuser.me/ that is built with React and Material-UI

OrgChart

---

Table of Contents

• Description
• Screenshots
• Dependencies
• Installation
• Configuration
• Usage
• Development
• Supported Versions
• Contributing
• Bugs and Issues
• License

Description

OrgChart is an example of a modern employee directory web application (frontend) that is written with React.

This application was created using create-react-app in combination with my NodeJS Repo Template project.

Screenshots

Employee Data Table

Sort Options

Filter Options

Coming Soon

Dependencies

Project Dependencies

• "@material-ui/core": "^4.11.3",
• "@material-ui/data-grid": "^4.0.0-alpha.22",
• "@material-ui/icons": "^4.11.2",
• "@testing-library/jest-dom": "^5.11.9",
• "@testing-library/react": "^11.2.5",
• "@testing-library/user-event": "^12.8.3",
• "axios": "^0.21.1",
• "gh-pages": "^3.1.0",
• "react": "^17.0.1",
• "react-dom": "^17.0.1",
• "react-scripts": "4.0.3",
• "web-vitals": "^1.1.1"

Development Dependencies

• "babel-eslint": "^10.1.0",
• "eslint": "^7.22.0",
• "eslint-config-prettier": "^8.1.0",
• "eslint-plugin-import": "^2.22.1",
• "eslint-plugin-jsx-a11y": "^6.4.1",
• "eslint-plugin-prettier": "^3.3.1",
• "eslint-plugin-react": "^7.22.0",
• "eslint-plugin-react-hooks": "^4.2.0",
• "prettier": "^2.2.1"

Installation

Installation Requirements

You will need NodeJS installed for use with this project.

Download

Download the zip or clone this project.

git clone https://github.com/davidsaulrodriguez/orgchart.git
cd orgchart/

Install

Now install the required dependencies with npm.

npm install

Configuration

To configure this application for use, you should create a .env file with your database information. For convience, a sample enviroment variable file can be found in the root directory with the name of: .env.example.

Usage

To start orgchart simply run:

npm run start

Development

While working and developing on the source code, you can run a live development server with:

npm start

Supported Versions

Below is a list of the currently supported versions of this software.

Note: This project is an ephemeral homework assignment and will not be worked on past its release (due date). Hence the week-long support life cycle.

Release	Status	Initial Release	Active LTS Start	Maintenance LTS Start	End of Life
develop	Unstable	-	-	-	-
v1	✔️	2021-03-23	-	-	2021-03-30

You can view the Status Key Map and software support model here.

Contributing

Contributions are more than welcome! If you improve on this project, please feel free to share it by submitting a Pull Request.

Before contributing, be sure to check out the CONTRIBUTING and Branching Model docs.

Bugs and Issues

Found a bug? Having an issue with this app? Open a new issue here.

License

This project and all of its source code is released and permissively licensed under the BSD 2 Clause license.