https://github.com/mobtimeapp/mobtime

A real-time, collaborative mob programming timer. Made with technology from the future, today!
https://github.com/mobtimeapp/mobtime

collaborative mob-programming mob-timer redis timer-application websocket

Last synced: 3 months ago
JSON representation

A real-time, collaborative mob programming timer. Made with technology from the future, today!

• Host: GitHub
• URL: https://github.com/mobtimeapp/mobtime
• Owner: mobtimeapp
• License: mit
• Created: 2020-03-18T01:35:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-29T13:46:44.000Z (9 months ago)
• Last Synced: 2024-01-22T01:25:02.239Z (5 months ago)
• Topics: collaborative, mob-programming, mob-timer, redis, timer-application, websocket
• Language: JavaScript
• Homepage: https://mobti.me
• Size: 6.95 MB
• Stars: 62
• Watchers: 5
• Forks: 38
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Lists

• hyperawesome - mobtime - A real-time, collaborative mob/ensemble programming timer. (Applications)

README

        
# mobtime

A websocket powered, collaborative mobbing timer, for desktop and mobile.

## Running Locally

### With Docker/Docker Compose

This is probably the preferred way, so you don't need to global install redis or even a specific node version.

 - `npm install`

 - `npm run tailwind`

 - `npm run start:dev`

### On your system

I'd only use this if you are using `nvm` or similar for node version management, and are okay with running a local redis server.

 - Install NodeJS LTS (>= v16.x officially, 12.x may still work though)

 - Install and run redis server

     - OSX+homebrew: `brew install redis`

     - Ubuntu: `sudo apt install redis-server`

     - Or google for your operating system's install instructions

 - `npm install`

 - `npm run tailwind`

 - `npm run start:dev`

### Configuration with .env

See [.env.example](./.env.example) for information on environment variables.

## Tips for running in production

 - Ensure `NODE_ENV` is set to production

 - Use `npm start` rather than `npm run start:dev`

 - Surprise find: If you are using phusion passenger to run your node application, you cannot use clustering

## Contributing

Bug reports and suggestions are welcome, just create an issue. PRs are welcome, too.

## License

It's under [MIT](./LICENSE.md).