California Moon Star

~ SQL Challenge: Employee Tracker 📝

Description

Motivation:

• We learned about how to use mysql queries and how to integrate it to Nodejs, to be able to manage a real database!

Why this project was created:

• In order to create and edit employees, managers, departments and roles in a company

What are we solving:

• we are providing an interface (although not that friendly) so the user can manage the database without the need of accessing the database directly.

What we learned / used:

• SQL Queries
• MySQL2
• Node.js
• Inquirer
• Chalk
• Figlet
• console.table()
• dotenv

Table of Contents

• Installation
• Usage
• Testing
• Contributions
• Credits
• License
• Questions

Installation

To run the project in your local machine:

1. Open visual studio in your computer or laptop
2. Clone the git project: https://github.com/lilianpatinoortiz/California-Moon-Star/
3. Pull the latest from the 'main' branch
4. Open a new terminal and type npm install to install the dependencies
5. Locate the server file and locate yourself there
6. Open a new terminal and type npm start or node server

Usage

Once you have your project running locally, you will be propted with a colorful header followed by a menu. Select one of the options on the menu to execute different actions with the company database! You can view the roles, departments and employees. You can add roles, employees and departments and you will be also able to update the employees manager!

You have at the end the option to exit, which will terminate the program. Happy coding!

Video of the app: https://drive.google.com/file/d/1EE7jLkMSXW42X5e-eE2Jt1NManjcGknf/view?usp=drive_link

Testing

This challenge does not contain specific test files, but below you can find a gif with the flow of the challenge functioning correctly.

Contributing

If you want to contribute on this project please contact me directly via email lilly.0608@gmail.com. Happy coding!

Credits

The main resources used:

• Module 12 information provided in canva
• Chalk: https://github.com/chalk/chalk
• Figlet: https://www.npmjs.com/package/figlet

License

Please refer to the license badge, on top of this file.

Questions

Any question, please feel free to contact me directly via email lilly.0608@gmail.com or via https://github.com/lilianpatinoortiz