Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/zbichsel/roster

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/zbichsel/roster
Owner: zbichsel
License: mit
Created: 2023-08-07T03:57:44.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-08-07T21:52:54.000Z (over 1 year ago)
Last Synced: 2024-11-19T15:58:18.660Z (2 months ago)
Language: JavaScript
Size: 2.34 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # roster

![Screenshot](./assets/images/Screenshot%202023-08-07%20at%204.19.26%20PM.png)

  ## Description

This is a back-end web application using the terminal to **Add**, **Update**, **Delete**, or **View** various positions, employees, and departments within the database. This **Roster** application is very useful in keeping track of an every evolving work environment.

  ## Table of Contents

  - [Installation](#installation)

  - [Usage](#usage)

  - [License](#license)

  - [Questions](#questions)

  ## Installation

Git clone the repository.

Please make sure that the **mysql2** and **inquirer** dependencies has been downloaded. If not, please run the following command:

`npm i inquirer`

`npm i mysql2`

This will install the MySQL and Inquirer packages and versions which are necessary for the application to run. Learn more about [Mysql2](https://www.npmjs.com/package/mysql2) and [Inquirer](https://www.npmjs.com/package/inquirer).

  ## Usage

To access this note taker application, please run the following command in your integrated terminal for this repository:

`node index.js`

  ## License

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

This project is licensed under MIT. Please check LICENSE document in repository for more information.

  ## How to Contribute

If you would like to contribute to this project, please open a new issue or submit a pull request.

  ## Tests

There are currently no test for this application

  ## Video

https://github.com/zbichsel/roster/assets/136612956/96c2c85f-daa1-4ac5-b07d-c5edc5863a9e

  ## Questions

  If you have any questions, feel free to reach me at [GitHub](https://github.com/zbichsel) or via email at [[email protected]]([email protected]).