GithubHelp home page GithubHelp logo

slack-presence's Introduction

Warning

This repository is not up-to-date and the symfony package used as security vulnerabilities, requiring an upgrade. I haven't had the time to handle that currently, and the lack of interest so far doesn't motivate me to do so, so use and adapt at your own risk. Feel free to contact/create an issue if interested anyway. - PG.

slack-presence

This project offers a set of simple commands that allows any company to track their staff schedule:

Recurrent schedule

A basic command allows people to inform where they will work each week day:

  • from Home
  • from Office
  • Doesn't work that day

The commands home, office or off are simply followed by the respective days: office monday thursday, home wed, off fri...

People's schedules are created the first time their use any command (see people) and default to every weekday being an office day. So basically, if someone only works from home on Wednesdays, then she would just type home wed and schedule will be set properly to office on Monday, Tuesday, Thrusday and Friday, and home on Wednesday.

The argument to the office, home, and off commands are week days, and only need the 3 first characters of the day name, case being ignored.

Specific events

A more complete command, set, allows everyone to set a specific event, be it working from home on a Wednesday when the person usually works from office that day, or a business travel for next week, or anything people want to let others know.

For instance, set home mon on a thrusday will set next week's Monday - exclusively - to home, whereas the normal recurring schedule will be applied on other Mondays after that.

The set commands accepts week days as arguments, but also specific dates, informed as a month and a day (e.g. March 3 or mar3), or any period that is expressed by a week day or a date followed by - followed by another week day or date (e.g. Thu - Mar 12)

set Vegas April 3 - April 17 will give you 2 weeks in Vegas, enjoy ;-) (joke!)

Showing schedules

To list people's schedules, just type people. You'll get current week's schedule as shown in the example below:

+============+===========+===========+===========+===========+===========+
| Person     | Monday 07 | Tuesda 08 | Wednes 09 | Thursd 10 | Friday 11 |
+============+===========+===========+===========+===========+===========+
|     andrew | ...... OFFICE ....... |   HOME    |  OFFICE   |   HOME    |
|    andrewk | ........................ OFFICE ......................... |
|     angela | ........................ OFFICE ......................... |
|    ciprian |  OFFICE   | ....... HOME ........ |  OFFICE   |   HOME    |
|     cydney | ......................... HOME .......................... |
|      daveb | ........................ OFFICE ......................... |
|      davec | ............ OFFICE ............. | ....... HOME ........ |
|       hawk | ......................... HOME .......................... |
|      jason |   HOME    |  OFFICE   |   HOME    |  OFFICE   |   HOME    |
|       judy | ......................... HOME .......................... |
|      leeia |  OFFICE   |   HOME    | ...... OFFICE ....... |   HOME    |
|    melanie |   HOME    | ............ OFFICE ............. |   HOME    |
|    michael | ............. HOME .............. |  OFFICE   |   HOME    |
|       phil | ...... OFFICE ....... |   HOME    |  OFFICE   |   HOME    |
|       rick | .................. OFFICE ................... |   HOME    |
|      sapna |   HOME    |  OFFICE   |   HOME    |  OFFICE   |   HOME    |
|       sara | ........................ OFFICE ......................... |
|      thais | ................... HOME .................... |   HOME*   |
|     thomas | ......................... HOME .......................... |
|      tolga | ......................... HOME .......................... |
|     travis | ........................ OFFICE ......................... |
|     victor | ........................ OFFICE ......................... |
|     yannie | ...... OFFICE ....... |   HOME    | ...... OFFICE ....... |
|       yuzo |   HOME    | ............ OFFICE ............. |   HOME    |
+============+===========+===========+===========+===========+===========+
| OFFICE --> |  54% (13) |  62% (15) |  45% (11) |  70% (17) |  29% ( 7) |
+============+===========+===========+===========+===========+===========+

people also show the number of people physically present at the office every day, which is useful if you need to order meals for lunch & learns, etc...

Also note specific schedules (not recurring) are shown with a *.

If you're on a phone, use compact instead, which will give you a narrower view more adapted to phones, without the stats line, and possibly without the * for specific schedules (depending on size available):

+============+===+===+===+===+===+
| Person     | M | T | W | T | F |
+============+===+===+===+===+===+
|     andrew | OFFIC | H | O | H |
|    andrewk | .... OFFICE ..... |
|     angela | .... OFFICE ..... |
|    ciprian | O | HOME  | O | H |
|     cydney | ..... HOME ...... |
|      daveb | .... OFFICE ..... |
|      davec |  OFFICE . | HOME  |
|       hawk | ..... HOME ...... |
|      jason | H | O | H | O | H |
|       judy | ..... HOME ...... |
|      leeia | O | H | OFFIC | H |
|    melanie | H |  OFFICE . | H |
|    michael | . HOME .. | O | H |
|       phil | OFFIC | H | O | H |
|       rick | .. OFFICE ... | H |
|      sapna | H | O | H | O | H |
|       sara | .... OFFICE ..... |
|      thais | ... HOME .... | H |
|     thomas | ..... HOME ...... |
|      tolga | ..... HOME ...... |
|     travis | .... OFFICE ..... |
|     victor | .... OFFICE ..... |
|     yannie | OFFIC | H | OFFIC |
|       yuzo | H |  OFFICE . | H |
+============+===+===+===+===+===+

If you need to see more than one week, 2weeks will show you this week and the next one, and month will show you this week and the next three ones (sliding month).

Available soon:

adding teams to the command will show you the same results but with people organized by team:

+============+===========+===========+===========+===========+===========+
| Person     | Monday 07 | Tuesda 08 | Wednes 09 | Thursd 10 | Friday 11 |
+============+===========+===========+===========+===========+===========+
|      davec | ............ OFFICE ............. | ....... HOME ........ |
|       yuzo |   HOME    | ............ OFFICE ............. |   HOME    |
+============+===========+===========+===========+===========+===========+
|     angela | ........................ OFFICE ......................... |
|      daveb | ........................ OFFICE ......................... |
|      jason |   HOME    |  OFFICE   |   HOME    |  OFFICE   |   HOME    |
|      leeia |  OFFICE   |   HOME    | ...... OFFICE ....... |   HOME    |
|    melanie |   HOME    | ............ OFFICE ............. |   HOME    |
|       sara | ........................ OFFICE ......................... |
|      thais | ................... HOME .................... |   HOME*   |
|      tolga | ......................... HOME .......................... |
+============+===========+===========+===========+===========+===========+
|     cydney | ......................... HOME .......................... |
|       judy | ......................... HOME .......................... |
|       rick | .................. OFFICE ................... |   HOME    |
|      sapna |   HOME    |  OFFICE   |   HOME    |  OFFICE   |   HOME    |
|     yannie | ...... OFFICE ....... |   HOME    | ...... OFFICE ....... |
+============+===========+===========+===========+===========+===========+
|       hawk | ......................... HOME .......................... |
|    michael | ............. HOME .............. |  OFFICE   |   HOME    |
|     travis | ........................ OFFICE ......................... |
+============+===========+===========+===========+===========+===========+
|     andrew | ...... OFFICE ....... |   HOME    |  OFFICE   |   HOME    |
|    andrewk | ........................ OFFICE ......................... |
|    ciprian |  OFFICE   | ....... HOME ........ |  OFFICE   |   HOME    |
|       phil | ...... OFFICE ....... |   HOME    |  OFFICE   |   HOME    |
|     thomas | ......................... HOME .......................... |
|     victor | ........................ OFFICE ......................... |
+============+===========+===========+===========+===========+===========+
| OFFICE --> |  54% (13) |  62% (15) |  45% (11) |  70% (17) |  29% ( 7) |
+============+===========+===========+===========+===========+===========+

Calendar

calendar shows you a simple calendar for previous month, current month and next month.

+==================================+
|             February             |
+====+====+====+====+====+====+====+
| Mo | Tu | We | Th | Fr | Sa | Su |
+====+====+====+====+====+====+====+
|  1 |  2 |  3 |  4 |  5 |  6 |  7 |
|  8 |  9 | 10 | 11 | 12 | 13 | 14 |
| 15 | 16 | 17 | 18 | 19 | 20 | 21 |
| 22 | 23 | 24 | 25 | 26 | 27 | 28 |
| 29 |    |    |    |    |    |    |
+====+====+====+====+====+====+====+

+==================================+
|              March               |
+====+====+====+====+====+====+====+
| Mo | Tu | We | Th | Fr | Sa | Su |
+====+====+====+====+====+====+====+
|    |  1 |  2 |  3 |  4 |  5 |  6 |
+····+····+····+····+····+····+····+
|  7 |  8 |  9 | 10 | 11 | 12 | 13 |
| 14 | 15 | 16 | 17 | 18 | 19 | 20 |
| 21 | 22 | 23 | 24 | 25 | 26 | 27 |
| 28 | 29 | 30 | 31 |    |    |    |
+====+====+====+====+====+====+====+

+==================================+
|              April               |
+====+====+====+====+====+====+====+
| Mo | Tu | We | Th | Fr | Sa | Su |
+====+====+====+====+====+====+====+
|    |    |    |    |  1 |  2 |  3 |
|  4 |  5 |  6 |  7 |  8 |  9 | 10 |
| 11 | 12 | 13 | 14 | 15 | 16 | 17 |
| 18 | 19 | 20 | 21 | 22 | 23 | 24 |
| 25 | 26 | 27 | 28 | 29 | 30 |    |
+====+====+====+====+====+====+====+

Holidays

Legal holidays are shown depending on user's country, with the holiday name or a * in the compact view.

(coming soon)

Defining teams

People can be assigned to teams.

(coming soon)

slack-presence's People

Contributors

peergum avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.