https://github.com/timeoffthescheduler/server

Server Side Implementation of TimeOff TS, A Scheduler
https://github.com/timeoffthescheduler/server

express express-js expressjs mongo mongodb mongoose mongoosejs node-js nodejs nosql saas scheduler vacations

Last synced: 3 months ago
JSON representation

Server Side Implementation of TimeOff TS, A Scheduler

• Host: GitHub
• URL: https://github.com/timeoffthescheduler/server
• Owner: timeoffthescheduler
• License: other
• Created: 2019-09-12T22:48:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T09:07:02.000Z (about 2 years ago)
• Last Synced: 2024-09-28T20:41:14.553Z (3 months ago)
• Topics: express, express-js, expressjs, mongo, mongodb, mongoose, mongoosejs, node-js, nodejs, nosql, saas, scheduler, vacations
• Language: JavaScript
• Homepage:
• Size: 10.9 MB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Your%20employees%20want%20to%20set%20vacation%20before%20taking%20their%20time%20off?%20Here%20is%20an%20open%20source%20project%20that%20can%20help%20you%20to%20set%20their%20vacations&url=https://github.com/zafar-saleem/timeoff-server)



  Facebook |

  Twitter |

  Reddit |

  Medium



### Note: This project is no longer maintained on this repository. It is moved to private repository.

**Note**: To use this project with built in user interface then use its client side implementation which could be found [here](https://github.com/timeoffthescheduler/app)

TimeOff is an application that allows companies and organizations to allow their employees to set vacations before they take their time off. TimeOff is an easy to use vacation setter with just few clicks.

TimeOff is completely open source meaning companies can use this project and set it up either internally or in the cloud for their use.

In addition, it is completely customizable i.e. companies can customize its user interface as well as can add new features or remove for their use both

on client and serverside.

### Set up is as easy as it can be

Setting up of this project is simply `clone it`, `npm install` for dependency installation and deploy.

### Architecture

Very simple and easy to scale architecture. All it needs is implementation of new services for new features and you are good to go.

## Technology stack

The technology stack used is below

* Node.js

* Express.js

* MongoDB

* Passport

## Client side of this project

The client side of this project could be found [here](https://github.com/timeoffthescheduler/app)

## Usage

To run this project locally, use `nodemon` package. Run `nodemon index.js` in timeoff-server folder which will run its server. Then use the client side and run its server using `npm start` command and visit the url mentioned in terminal of the client side.

![Video](screenshots/timeoff-setup.gif)

**Note**: Don't forget to setup database before following above video to setup this project.

## Database

This project requires setting up your own database on your machine. Please follow below links.

* [Windows](https://docs.mongodb.com/v3.2/tutorial/install-mongodb-on-windows/)

* [MacOS](https://www.code2bits.com/how-to-install-mongodb-on-macos-using-homebrew/) Make sure that homebrew is already installed on your machine.

Once you have that setup, make one admin account in Users collection, with properties username, password, email and role(which should be set to admin).

To create an admin user, go to `http://localhost:PORTNUMBER/register` and enter admin's details. Click register. Then go to mongodb CLI. use timoff database and use below query to update user's role to Admin.

`db.users.update({"username": "root"}, {$set:{"role":"Admin"}})`

![Video](screenshots/timeoff-admin-account.gif)

# Contributions

In order to contribute, please open issues and make pull requests.

# Contact

[email protected]