embashgit / enhanced-hr

Human Relation Manager

Enhanced HR

Enhanced Human Relation manager

Summary

​

• Getting Started
• Runing the tests
• Deployment
• Versioning
• Repo Structure
• Authors
• License
• Acknowledgments ​

Getting Started

• clone the repo using git clone https://github.com/embashgit/enhanced-hr.git
• install the dependencies using npm install
• start the development server using npm run dev
• visit http://localhost:4005 on your browser and you will be presented with the Main page

Screen Record(s)

Dependencies

• Node v12.19.0
• TypeScript
• TailwindCss
• Redux

Prerequisites

The following are required to run the app

• node v12

Setup

• clone the repo using git clone https://github.com/embashgit/enhanced-hr.git
• install the dependencies using npm install
• start the development server using npm run dev
• visit http://localhost:4005 on your browser and you will be presented with the Main page
• run npm run lint to lint code
• run npm run format to format your code with prettier for a better developer experience

Running the tests [QA]

• To run the tests simply use npm test ​However this isnt covered on this project

Deployment [DevOps]​

To deploy this app follow the steps below:

• Run npm run build and a production optimized version of the app will be built
• Start the app using npm run dev.

A Dockerfile is also provided for container creation. ​

Versioning [Dev]

• N/A​ ​

Repo Structure

├── README.md
├── .gitignore
|---LICENSE

Authors [Dev]

• Ibrahim Bashirhttps://github.com/embashgit ​

License

​ This project is licensed under the GNU General Public License v3.0 License - see the LICENSE.md file for details ​

Acknowledgments