mechabubba / bomo

🃏 An open source take on the classic Mattel card game UNO, playable via web browser.

bomo

An open source take on the classic Mattel card game UNO, playable via web browser.

contributing

See our issue tracker for feature requests, bug reports, etc.

If you want to contribute yourself, let us know on an issue or contact us in our discord:

install

• Install node.js, npm or pnpm, and git
• Clone via git clone https://github.com/mechabubba/bomo.git
• Run npm install or pnpm install in the root to install dependencies
• If you want, copy & rename template.env to .env to edit whatever variables you want before starting. If you don't, it'll do this for you without changing anything
• Run node index.js or npm start to start the server and you're good to go
  • To change the port, edit your .env file and restart

update

• Run git pull origin

• Manually update your .env file if any new variables were added in template.env and you're good to go

disclaimer

This project is not associated with UNO, Mattel, or Ubisoft in any way.

credits & attributions

• UNO® by Mattel, Inc for inspiration
• Silk Icons, an icon set by Mark James
• Node.js® JavaScript runtime
• npm, JavaScript package manager
• pnpm, fast & disk space efficient JavaScript package manager
• eslint, a configurable JavaScript linter
• JSDoc, inline JavaScript documentation & docs generation
• boxy-jsdoc-template, a clean template theme for JSDoc 3
• pngcrush, an optimizer for PNG files
• The Twelve-Factor App, good guidance regarding app design
• restfulapi.net, good guidance regarding api design
• stackoverflow.blog's Best practices for REST API design, good article on rest apis
• TopHattWaffle for this photo of their 3D printed source engine errors (used on the 404 page)
• discord.js, for coding practices and educational value

Dependencies

• tinyhttp, a lightweight express-like web framework
• ejs, embedded JavaScript templating
• sirv, lightweight middleware for serving static assets
• @tinyhttp/cookie-parser, cookie parsing
• Luxon, modern wrapper for JavaScript dates and times
• dotenv, zero-dependency module for .env file support
• Google Fonts, an open font cdn

Extensions

• ESLint, visual studio code extension by Dirk Baeumer
• EJS language support, visual studio code extension by DigitalBrainstem
• Prettier, an opinionated code formatter for visual studio code