These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The following software is required to be installed on your system:
We recommend using asdf version manager to install and manage all the programming languages' requirements.
This project uses the Spotify API for adding new songs. You need to create an App to interact with it in development here.
First, clone the repository:
git clone [email protected]:cesium/karaokium.git
cd karaokium
Then, run the setup script to get all dependencies configured. The default
value for ENV is dev.
bin/setup [ENV]
Then you should change the .env.dev file as needed. Run this script again
if needed.
Start the development server and then you can visit http://localhost:4000
from your browser.
mix phx.server # or iex -S mix phx.server
Lint your code.
bin/lint
Format your code.
bin/format
You can use these resources to learn more about the technologies this project uses.