- Data Models
- User
- email & password Authentication
- email verification
- password security
- Image
- Marker (Comment Thread)
- Comment
- User
- APIs
- User
- Me (current signed in user)
- Image
- Marker
- Comment
- Dockerize
- API call triggers server broadcast events to all connected clients
- Project Repo Scaffolding using some boilerplate I used before
- Development Environment
- Docker Desktop WSL
- Docker Compose with Compose V2 enabled
- MongoDB
- Set MongoDB credentials in secret/.env, create this file if it doesn't exist
- MONGO_INITDB_ROOT_USERNAME=
- MONGO_INITDB_ROOT_PASSWORD=
npm run docker-upwill spin up the MongoDB
- Data Models
- Mongoose ODM
- typegoose, never used before, evaluate if the code could be cleaner
- Unit tests using Mocha and Chai
- User
- Basic email address format validation
- Store password using scrypt
- API
- Koa.js
- Manual test using VSCode extension REST Client with test/api.http (instead of Postman)
- API Tests using node-fetch
- User
addUserfor Registration
- Me
getMefor session validationputMefor sign indelMefor sign out
- Image
listImagefor listing all imagesaddImagefor adding an image metadatagetImagefor getting an image metadataupdateImagefor updating an image metadata (move image position)putImagefor uploading an image than redirect to the image URL
- Marker
listMarkerfor listing all markersaddMarkerfor adding a markergetMarkerfor getting a markerupdateMarkerfor updating a marker (move marker position)delMarkerfor deleting a marker (resolve thread)- Comment
listCommentfor listing comments of a marker (in a thread)addCommentfor adding a comment to a marker (to a thread)delCommentfor deleting a comment from a marker (from a thread)
- Dockerfile
- Realtime
- Socket.io
- Server events
savedemitted when added or updated, event data contains one of these fields:- image
- marker
- comment (client emitting
subscribeMarkeris required to receive)
removedemitted when deleted, event data contains one of these fields:- imageId
- markerId
- commentId (client emitting
subscribeMarkeris required to receive)
- Client events
subscribeMarkerfor subscribing to events of comments under a marker (open the comment dialog)unsubscribeMarkerfor unsubscribing from events of comments under a marker (close the comment dialog or marker removed)