canvasbird/canvasboard-backend

Canvasboard Backend built on NodeJS🚀

canvasboard-backend's Issues

Make ER diagram from existing schema

Documentation Needed 📃

Canvasboard backend had a well-defined ER diagram, but with constant changes, we didn't get time to update our ER diagram to the latest schema that is being used right now.

Its Reverse Engineering Time; 😎
MongoDB schema is well defined here: APIs\models\collections, it would be great to have an updated ER diagram for the same.

Prefered Tool: Draw.io

note: don't worry about the relation between other tables (collection as we call it the NoSQL world)

Generated unique URL's for sharing files

Postman API Documentation

Documentation Needed 📃

Canvasboard Backend has around 30 APIs, some of the postman docs can be found here as APIs\apiDocs but they are either not properly documented or missing most of the APIs.

Would be great to have a proper well-documented postman collection for all the APIs that canvasboard uses, also attaching some resources below to get you started with the postman documentation. 👇🏻

Postman Official Blog
Youtube Tutorial

Proper status codes

Proper status codes on responses.

Add distroless base image and layer optimization

Requirements

1. Adding distroless base image,
   Comment: Adding distroless base image ensures shell is not accessible and hence more secure.
2. Layer optimization for quick and efficient builds.
   Comment: Leveraging cache for faster builds

Better Looking Email Templates

Problem 🚩

• Canvasboard sends a verification email to the user upon every new registration and also when the user clicks on forgot password.
• Currently, they look something like this. 👇🏻

• This email body is written in HTML; existing code can be found here APIs\controllers\authCtrl.js in forget() & register() controllers

Solution Wanted ✅

• Come up with a better looking HTML template for the same
• Use inline css for a more attractive template
• BONUS: you can use gif too 😅

Automate backend development setup

Automate the backend development setup with a simple script to minimize the manual work.

Implementing Folder Structure

Currently, all files that the user has is directly attached to the user, we want to implement a folder structure,
user--will have-->folders--will have-->files

This will help in keeping the file management clean, so eventually, CURD APIs for the folders are needed and modifying files relationship with the user.

files--will have a relationship with-->folders--will have a relationship with-->user

Replace the .env template

Issue:
The .env template is missing.

Issues template

Issues Template for backend same as which is in the frontend.

Add Forgot Password / Reset Password functionality

Canvasbird uses both vanilla email_id/password login along with google sign in using passport-js strategy,

Whenever a new user registers we send him a confirmation email to reduce spam email registration, we also want a forgot password functionality to be added for obvious reasons and keeping the UX in mind.

Do not send JSON response for email verified successfully / unsuccessfully

You should not be sending a JSON response when email has been verified successfully / unsuccessfully

Local Setup

It's always better to have a script which can setup local environment.