The project is a mono-repo setup managed by lernajs and has the following packages:
- @jukejoint/common (models and other shared util methods)
- @jukejoint/frontend (frontend ui)
- @jukejoint/streamer (koa backend with streaming)
You have to install the ffmpeg package for the server to be able to convert the song streams. If you have homebrew
installed then simply run brew install ffmpeg and you are done.
Run yarn start at the root of the repository. This will start all three packages in watch mode.
To submit code just branch off from latest master and do a pull request.
Pushing directly to
masterbranch is protected
When doing commit messages it's nice that you use emoticons because life is too short not too.
Though you can be creative it's good to have a standard. Here are some to follow:
- 🎨
:art:- Improving strucutre/format of the code - ⚡
:zap:- General enchancements - 🐛
:bug:- Bug fixes - 🚑
:ambulance:- Hot fixes that are pushed to production in out of release cycle way - ✨
:sparkles:- New features - 🚧
:construction:- Work in progress and most probably not stable - ⬆️
:arrow_up:- Upgarding packages etc - 🤝
:handshake:- Merging - 🚀
:rocket:- Deploying stuff - 🔧
:wrench:- Development environment or process related commits - 👮
:cop:- Adding tests - ♻️
:recycle:- Refactoring code - 📝
:memo:- Writing docs - 💄
:lipstick:- UI/UX and style changes