Skip to content

smilegupta/notes-yard-backend

Repository files navigation

Notes Yard

Open Source Love Awesome Made With Love

Notes Yard is a highly scalable, low cost and high performant one stop solution to:

  • Uploading images, gettting sharable link and getting iframes to add to your website
  • A Markdown Editor
  • Creating private notebooks and notes

Project Overview

Application Links

Frontend Code -> https://github.com/smilegupta/notes-yard-frontend
Deployed URL -> https://notes-yard.smilegupta.tech/
Backend Code -> https://github.com/smilegupta/notes-yard-backend
API Docs -> https://notesyard-api.smilegupta.tech

Tech Stack

Frontend: Reactjs
Additional NPM Libraries

  • react-toastify
  • react-router-dom
  • react-router-bootstrap
  • react-password-mask
  • react-modal
  • react-copy-to-clipboard
  • react-quill
  • react-bootstrap
  • axios
  • aws-amplify
  • @tippyjs/react
  • react-markdown
  • react-qr-code
  • html-react-parser
  • dompurify

Styling: CSS and BootStrap
Database: DynamoDB
Authentication and Authorisation: Cogito and Amplify
Storing Images: S3
Compute: AWS Lambda
Deployment: CI/CD setup using GitHub Actions via Serverless Framework

Architectural Diargram

Overall Functionality

  • Uploading a paste (publically) and getting a sharable link.
  • An MD Previewer
  • Ability to make private notebooks and adding notes.
  • User Management (Login, register, sending confirmation link, forgot password and email verification before entering the system)
  • Authenticated Routes and 404 error page.

Upcoming Features

  • Sharable SWOT Board for Analysis

Glad to see you here! Show some love by starring this repo.

Facebook Instagram LinkedIn Twitter