BOSSY 👨‍💻

Introduction

This is an entire API and a unique employee management application to serve information for today's most accomplished entrepreneurs. It helps entrepreneurs keep track of their employees and handle all the annoying meetings that keep getting added to their busy schedule. It also helps them to organize their brilliant ideas in a click.

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

• NodeJS
• MongoDB Compass (Optional)

Usage ✨

1. git clone https://github.com/sharmaaditya570191/BossY.git

2. Navigate to the project's directory using: cd bossy

3. Run npm install in the root directory to install the dependencies.

4. Run npm run start-server to start the server and watch for changes

5. Run npm start to run the front-end only

Technology stack 💻

• Frontend : It is made using React, HTML and CSS and you can customize the look of the Boss Machine by accessing the code in the src folder.

• Backend : It is made using Express.js and is present in the server folder.

• Database : MongoDB is used and the schemas are defined using Mongoose as ORM. This can be found in models folder.

• Tests ⚠️ : The tests are written using Mocha and Chai as the assertion library and are present in the test folder.

Contribution 🤝

Start working on a feature by making a separate branch and make commits with meaningful messages. Feel free to open new-issues if you encounter bugs or want to suggest some enhancement in the app.

Before contributing to this project do check CONTRIBUTING.md file and CODE_OF_CONDUCT.md file.

Testing 🧪

Tests are given in the test/test.js file. To run the tests, first open the root project directory in your terminal. Then run npm test. You will see a list of tests that ran with information about whether or not each test passed.

Contact Us 📝

Join the BOSSY slack workspace here 🙌.