Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

A database that helps keep track of relationships between employees and managers is helpful for management.
https://github.com/andrewhamerly/employee-tracker

inquirer inquirerjs node-js nodejs npm pg pgsql postgres postgresql postgresql-database

Last synced: about 19 hours ago
JSON representation

A database that helps keep track of relationships between employees and managers is helpful for management.

Host: GitHub
URL: https://github.com/andrewhamerly/employee-tracker
Owner: andrewhamerly
License: mit
Created: 2024-05-08T19:18:41.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-05-16T19:01:06.000Z (4 months ago)
Last Synced: 2024-09-19T13:35:24.103Z (9 days ago)
Topics: inquirer, inquirerjs, node-js, nodejs, npm, pg, pgsql, postgres, postgresql, postgresql-database
Language: JavaScript
Homepage:
Size: 24.4 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

  Organizing, recognizing, and appreciating employees is foundational to good business.

A database that helps keep track of relationships between employees and managers is helpful for management.

Enter the Employee Tracker, a simple node.js app that connects with a Postgres database to help retain employee information.

  ## Table of Contents

  - [Installation](#installation)

  - [Usage](#usage)

  - [License](#license)

  - [Contributing](#contributing)

  - [Tests](#tests)

  - [Questions](#questions)

  - [Credits](#credits)

  ## Installation

  Steps to kickstart the project:
1. **Copy Link**: Hit the "Code" button in this GitHub repo to copy the link.
2. **Clone**: In GitBash, execute the command `git clone [paste link here]`.
3. **NPM**: Install Node Package Manager with `npm init -y`.
4. **Inquirer**: Get npm's inquirer package by running `npm install inquirer`.
5. **PG**: Get npm's pg package by running `npm install pg`.
6. **PostgreSQL**: Setup PostgreSQL database by running `psql -U postgres` followed by entering your user database password and then creating the database by running `\i db/schema.sql`.
7. **Seeding**: Optionally, you can seed the database with info by running `\i db/seeds.sql`.

  ## Usage

  Once the software is downloaded, Node packages are initialized, and your PostgreSQL database is active, let's begin!

Navigate to the project directory and initiate prompts using `node server.js`.

Then, select your desired action and the employee database will be updated.


  [Link to video demo of Employee Tracker](https://drive.google.com/file/d/1T2dpu6FkggHc-qDtRBw6Dt7xL6X0pqvk/view?usp=drive_link)

  ## License

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


  [License Guide](https://opensource.org/licenses/MIT)


  This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

  ## Contributing

  Please enter a new issue in the GitHub repo. Thanks!

  ## Tests

  There are no tests for this app.

  ## Questions

  [GitHub Profile](https://github.com/andrewhamerly)


  If you have additional questions, please email me at [email protected].

  ## Credits

  My tutor for help with the DB class with constructor and async query.