collab-playlist

A full stack app developed for research on Collaborative Playlists.

Tip: pay careful attention to which directory to perform each of these tasks in.

How to set up for development

1. In project root directory (collab-playlist/), run npm ci.
2. In the client/ directory, run npm ci.
3. Create a .env file in the root directory formatted like .env.example with the values after the equal signs filled in. Use the comments to guide you.
4. Create a .env file in the client/ directory formatted like client/.env.example with the values after the equal signs filled in. Use the comments to guide you.
5. Create an ids.csv file (or name it whatever you named DB_IDS in .env) in the db/ directory to list playlists and users in each group. Use ids.csv.example to guide you. You must first create playlists in Spotify using the "owner account" to get the playlist ids to put in ids.csv.

How to run / create development build

1. You will need to run 3 commands in parallel. Usually the easiest way to do this is to open three terminals. In the following order:
2. In the first terminal, in the project root directory, run npm run build-watch.
3. In the second terminal, in the project root directory, run npm run watch.
4. In another temporary terminal, in the project root directory, run source .env then curl -XPOST -b admin_key=$ADMIN_KEY localhost:$PORT/admin/load-ids.
5. In the third terminal, in the client/ directory, run npm start. A browser will open with the app.

How to set up for production

1. In project root directory (collab-playlist/), run npm ci.
2. In the client/ directory, run npm ci.
3. Create a .env file in the root directory formatted like .env.example with the values after the equal signs filled in. Use the comments to guide you.
4. Create an ids.csv file (or name it whatever you named DB_IDS in .env) in the db/ directory to list playlists and users in each group. Use ids.csv.example to guide you. You must first create playlists in Spotify using the "owner account" to get the playlist ids to put in ids.csv.

How to create production build

1. In the root directory, run npm run build. The output will be in build/.
2. In the client/ directory, run npm run build. The output will be in client/build/.
3. In the root directory, run npm start to start the server.
4. In another temporary terminal, in the project root directory, run source .env then curl -XPOST -b admin_key=$ADMIN_KEY localhost:$PORT/admin/load-ids.