Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
daneisburgh committed Oct 14, 2023
1 parent a753a37 commit 60e1f0f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Practical Tuples

This project is a "to-do list" type application built on serverless real-time architecture. Users can create and share lists as well as manage access without requiring traditional account info (i.e. username and password). The app's frontend is built with [Angular](https://angular.io/) and the backend is built with [NestJS](https://nestjs.com/), and uses a [PostgreSQL](https://www.postgresql.org/) relational database. The app can be hosted in AWS with the frontend in [S3](https://aws.amazon.com/s3/) and the backend in [Lambda](https://aws.amazon.com/lambda/), managed by the [Serverless](https://www.serverless.com/) framework. Real-time communication between the frontend and backend is performed by persistent websocket connection that is maintained by [API Gateway](https://aws.amazon.com/api-gateway/).
This project is a real-time and cross-platform "to-do list" application built on serverless architecture. Users can create and share lists as well as manage access without requiring traditional account info (i.e. username and password). The frontend is built with the [Ionic Framework](https://ionicframework.com/) and can be compiled as a web, Android, and/or iOS application. The backend is built with [NestJS](https://nestjs.com/), and uses an [AWS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) relational database. The app can be hosted in AWS and managed by the [Serverless Framework](https://www.serverless.com/). Real-time communication between the frontend and backend is performed by persistent websocket connection that is maintained by [API Gateway](https://aws.amazon.com/api-gateway/).

[![Integration](https://github.com/daneisburgh/practical-tuples/actions/workflows/integration.yml/badge.svg)](https://github.com/daneisburgh/practical-tuples/actions/workflows/integration.yml)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
Expand Down

0 comments on commit 60e1f0f

Please sign in to comment.