Enhanced Human Relation manager
- Getting Started
- Runing the tests
- Deployment
- Versioning
- Repo Structure
- Authors
- License
- Acknowledgments
- 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
- Node v12.19.0
- TypeScript
- TailwindCss
- Redux
The following are required to run the app
- 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
- To run the tests simply use
npm test
However this isnt covered on this project
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.
- N/A
├── README.md
├── .gitignore
|---LICENSE
- Ibrahim Bashirhttps://github.com/embashgit
This project is licensed under the GNU General Public License v3.0 License - see the LICENSE.md file for details