Initial commit

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -0,0 +1,42 @@
+# Jukebox Pro
+
+Introducing Jukebox Pro, the successor to Jukebox! Users will now need to make an account and log in before they are able to manage their playlists.
+
+## Database
+
+![Visual representation of the database schema linked below](/docs/schema.svg)\
+_[textual representation of the database schema in DBML](/docs/schema.dbml)_
+
+1. Create a new Postgres database named `jukebox-pro`.
+2. Initialize Prisma and connect it to the database.
+3. Define the models according to the schema above.
+   - The `username` of a User must be unique.
+4. Seed the database with at least 20 tracks.
+
+## API
+
+Build an Express app that serves the following routes.
+
+The 🔒 lock icon next to a route indicates that it must be a protected route. A user can only access that route by attaching a valid token to their request. If a valid token is not provided, immediately send a 401 Unauthorized error.
+
+### Authentication Routes
+
+- `POST /register` creates a new User with the provided credentials and sends a token
+  - request body should include username and password
+  - the password should be hashed in the database
+- `POST /login` sends a token if the provided credentials are valid
+  - request body should include username and password
+
+### Playlist Routes
+
+- 🔒 `GET /playlists` sends array of all playlists owned by the logged in user
+- 🔒 `POST /playlists` creates a new playlist owned by the logged in user
+  - the request body should include the name, description, and trackIds
+- 🔒 `GET /playlists/:id` sends specific playlist, including all tracks
+  - if the logged-in user does not own this playlist, send a 403 Forbidden error
+
+### Track Routes
+
+- `GET /tracks` sends array of all tracks
+- `GET /tracks/:id` sends specific track
+  - if user is logged in, then also include all playlists owned by the user that have this track

docs/schema.dbml

@@ -0,0 +1,23 @@
+Table User {
+  id        Int     [pk, increment]
+  username  String  [unique]
+  password  String
+  playlists Playlist[]
+}
+
+Table Playlist {
+  id            Int     [pk, increment]
+  name          String
+  description   String
+  owner         User
+  tracks        Track[]
+}
+
+Table Track {
+  id        Int [pk, increment]
+  name      String
+  playlists Playlist[]
+}
+
+Ref: User.playlists < Playlist.owner
+Ref: Playlist.tracks <> Track.playlists

package.json

@@ -0,0 +1,11 @@
+{
+  "name": "38-jukebox_pro",
+  "version": "1.0.0",
+  "description": "Introducing Jukebox Pro, the successor to Jukebox! Users will now need to make an account and log in before they are able to manage their playlists.",
+  "main": "server.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC"
+}