Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.37 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.37 KB
Raw

Google Keep Clone

A work-in-progress open source clone of the Google Keep app using TypeScript, React, Next.js, Serverless Stack(SST) and microservice architecture. Access a live deployment here.

About this project

This purpose of this project is to showcase the implementation of the libraries and architectures mentioned above.

Packages

The packages involved in this monorepo are as follows

  • Root - SST configuration
  • web - Frontend application with Next.js
  • eslint-config-custom - custom reusable ESLint config for other packages
  • core - main library for common types, utils, functions, etc.
  • functions - Lambda functions for SST

Running Locally

  1. Install dependencies using pnpm:
pnpm install

  1. Configure AWS Credentials locally. You can refer to this guide - SST - IAM Credentials. The AWS account to be used must be verified so that Cloudfront resources may be deployed. See this reference

  2. Start the development server

nx run-many -t dev

Roadmap

Incoming features or updates include but are not limited to the following:

  • Testing
  • Observability
  • Logging
  • UI and UX improvements
  • CI/CD pipelines