TIM3BOT is lightweight, conversational tool for tracking goals and time estimation across various teams here at Flux.io. It asks you to make ~3 large commitments to your team per week, plus how many days of effort you believe each commitment represents. TIM3BOT then checks in with you regularly and provides you a score so you can see your estimation efficiency week-to-week.
- Install and start Redis
- On OSX, we recommend using Homebrew and automatically starting the server on login:
$ brew update
$ brew install redis
$ brew services start redis
- Install and start Postgres
- On OSX, we recommend using Homebrew and automatically starting the server on login:
$ brew update
$ brew install postgres
$ brew services start postgresql
- Create a Postgres database and, if necessary, superuser, e.g.:
$ createuser -s postgres
$ createdb tim3bot
- Clone the repo and install the Node dependencies:
npm install
- Create a new bot on Slack (we call ours "tim3bot").
- Set up your environment
- Start the server:
npm run start:watch
- Navigate to http://localhost:4000
SLACK_CLIENT_ID
: The Slack app's client IDSLACK_CLIENT_SECRET
: The Slack app's client secretSLACK_API_TOKEN
: The api token you get for your newly-created bot on Slack.DB_NAME
: The postgres database name, e.g.,tim3bot
DB_USER
(optional, default:postgres
): The postgres database userDB_PASSWORD
(optional): The postgres database passwordNODE_ENV
*(optional, default:development
): The current environment, e.g.,development
orproduction
PROXY_PORT
*(optional, default:4000
): The port for the server that you will access in the browserAPI_PORT
*(optional, default:4001
, alias:PORT
): The port for the main serverSTATIC_PORT
*(optional, default:4002
): The port for the Webpack server