Clone the repo using git:
cd ~/Folder/you/want/to/clone/this/repository/into
git clone https://github.com/check24-scholarships/music-synchronizer.git
Tip: Use Tab to complete terminal commands and show suggestions
Open the project in Visual Studio Code, (recommended IDE) (code editor):
cd music-synchronizer
code .
Trust the folder and install all recommended extensions
Installation instructions for Visual Studio Code:
(Linux)pacman -S code
(limited OSS version) /yay -S visual-studio-code-bin
(Research required!)
(macOS)brew install --cask visual-studio-code
(Windows)winget install -e --id Microsoft.VisualStudioCode
Create a .env
file and set required environment variables (have a look at env.example
)
You can obtain your own GOOGLE_CLIENT_ID
and GOOGLE_CLIENT_SECRET
in the Google Developer Console
You can obtain your own Spotify SPOTIFY_CLIENT_ID
and SPOTIFY_CLIENT_SECRET
in the Spotify Developer Dashboard
COOKIE_SECRET=<40-50 character long password>
# you can generate a random 50-character string e.g. with `cat /dev/urandom | LC_ALL=C tr -dc 'a-zA-Z0-9' | fold -w 50 | head -n 1`
BASE_URL=http://localhost:3000
GOOGLE_CLIENT_ID=<your google client id>
GOOGLE_CLIENT_SECRET=<your google client secret>
SPOTIFY_CLIENT_ID=<your spotify client id>
SPOTIFY_CLIENT_SECRET=<your spotify client secret>
DATABASE_URL=<your database connection url>
Install the dependencies of the Project (You can open up a new terminal in Visua Studio Code with Ctrl + J):
npm i
Setup the database
npm run new
Start a local development server
npm run dev
Happy hacking! 🥳