Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharmaadityahq/bossy
a unique employee management application to enable today's most accomplished entrepreneurs
https://github.com/sharmaadityahq/bossy
bootstrap chai css express-js html javascript linux mocha node-js react
Last synced: about 2 months ago
JSON representation
a unique employee management application to enable today's most accomplished entrepreneurs
- Host: GitHub
- URL: https://github.com/sharmaadityahq/bossy
- Owner: sharmaadityaHQ
- License: mit
- Created: 2019-11-04T06:10:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-31T18:41:26.000Z (over 4 years ago)
- Last Synced: 2024-11-07T09:02:43.580Z (about 2 months ago)
- Topics: bootstrap, chai, css, express-js, html, javascript, linux, mocha, node-js, react
- Language: JavaScript
- Homepage:
- Size: 1.61 MB
- Stars: 16
- Watchers: 5
- Forks: 51
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BOSSY 👨💻
[](https://github.com/sharmaaditya570191/BossY/blob/master/LICENSE) [](https://github.com/vinitshahdeo/Water-Monitoring-System/stargazers) [](https://github.com/sharmaaditya570191/BossY/network/members) [](https://github.com/sharmaaditya570191/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](https://nodejs.org/en/download/)
- [MongoDB Compass](https://www.mongodb.com/download-center/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](https://github.com/sharmaaditya570191/BossY/tree/master/server) folder.
- **Database** : `MongoDB` is used and the schemas are defined using `Mongoose` as ORM. This can be found in [models](https://github.com/sharmaaditya570191/BossY/blob/master/server/models) folder.
- Tests ⚠️ : The tests are written using `Mocha` and `Chai` as the assertion library and are present in the [test](https://github.com/sharmaaditya570191/BossY/tree/master/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](https://github.com/sharmaaditya570191/BossY/issues/new) if you encounter bugs or want to suggest some enhancement in the app.
Before contributing to this project do check [CONTRIBUTING.md](./CONTRIBUTING.md) file and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) file.
## Testing 🧪
Tests are given in the [test/test.js](https://github.com/sharmaaditya570191/BossY/blob/master/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](https://join.slack.com/t/bossy-in/shared_invite/zt-eqrnazbm-wCb3HrboYulscaakRlaBPw) 🙌.
[](https://github.com/sharmaaditya570191/) [](https://github.com/sharmaaditya570191/)