Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bryceberczik/employee-tracker

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/bryceberczik/employee-tracker
Owner: bryceberczik
License: mit
Created: 2024-08-16T20:57:33.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-08-19T20:22:22.000Z (3 months ago)
Last Synced: 2024-08-21T00:00:11.093Z (3 months ago)
Language: TypeScript
Size: 952 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Employee Tracker

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Description
This application is an Employee Tracker, designed to manage and organize employee information within a company. It provides a command-line interface (CLI) for users to interact with a database, allowing them to perform various operations related to employees, departments, and roles.

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Contributing](#contributing)
- [Tests](#tests)
- [Questions](#questions)

## Installation
In order to use this application, you must install node.js as well as postgresql in order to have the code work as promised.

## Usage
In order to run and use this application, you must right click the db folder and run the scheme.sql and seeds.sql using the commands \i schema.sql etc. in order to access the postgres CLI you must type in psql -U postgres and enter your pass word. Optionally, you can choose to have a blank slate. Right click the src folder and open intergrated terminal, and run the command, "npm run start" this will run the application and you can add departments, roles, and employees, even managers to start your companys database.

$running \i schema.sql;$
$running \i seeds.sql;$
running the application

https://github.com/user-attachments/assets/f818ae15-2e9b-41c9-bb1e-2984a55b9a0f

## License
This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license.

## Contributing
Contributions are welcome! If you have suggestions for improvements or new features, please create an issue or submit a pull request. For major changes, please open an issue first to discuss what you would like to change. Thank you!

## Tests
The test instructions are a npm run build which will transpile your code into javascript formatting, and also a npm run start that will build and run your application, (It is reccommended to run a npm run start for easy access to the appllication.)

## Questions
If you have any questions, you can reach me at [[email protected]](mailto:[email protected]). You can also find more of my work at [bryceberczik](https://github.com/bryceberczik) on Github.