-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
28a04a9
commit 63134cd
Showing
1 changed file
with
13 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Practical Tuples | ||
|
||
This project is a to-do type application built on serverless real-time architecture. 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/). | ||
|
||
[![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) | ||
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) | ||
|
||
## Development | ||
|
||
1. Install [Docker](https://www.docker.com/get-started/) and [Node.js LTS](https://nodejs.org/en/download/) | ||
2. Install all project dependencies: `npm run install-all` | ||
3. Start local server: `npm start` |