Update README.md
This commit is contained in:
parent
9ec8e5ea3b
commit
8e70340666
130
README.md
130
README.md
@ -1,66 +1,66 @@
|
|||||||
# Cloud Notes Platform – Cloud-Native Notes Management Application
|
# Cloud Notes Platform – Cloud-Native Notes Management Application
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
|
||||||
Muhilan
|
Nihal Ahmed
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Overview
|
# Overview
|
||||||
|
|
||||||
Cloud Notes Platform is a modern cloud-native notes management web application developed using containerized deployment architecture and public cloud infrastructure.
|
Cloud Notes Platform is a modern cloud-native notes management web application developed using containerized deployment architecture and public cloud infrastructure.
|
||||||
|
|
||||||
The application allows users to:
|
The application allows users to:
|
||||||
- create notes
|
- create notes
|
||||||
- store notes persistently
|
- store notes persistently
|
||||||
- manage lightweight note workflows
|
- manage lightweight note workflows
|
||||||
- access the application securely over HTTPS
|
- access the application securely over HTTPS
|
||||||
|
|
||||||
The system is designed using a multi-component architecture consisting of:
|
The system is designed using a multi-component architecture consisting of:
|
||||||
- Flask backend application
|
- Flask backend application
|
||||||
- PostgreSQL database
|
- PostgreSQL database
|
||||||
- NGINX reverse proxy
|
- NGINX reverse proxy
|
||||||
|
|
||||||
The application is deployed on an AWS EC2 virtual machine using Docker Compose orchestration and HTTPS reverse proxy configuration.
|
The application is deployed on an AWS EC2 virtual machine using Docker Compose orchestration and HTTPS reverse proxy configuration.
|
||||||
|
|
||||||
The project demonstrates practical cloud deployment concepts including:
|
The project demonstrates practical cloud deployment concepts including:
|
||||||
- containerization
|
- containerization
|
||||||
- reverse proxy configuration
|
- reverse proxy configuration
|
||||||
- persistent storage
|
- persistent storage
|
||||||
- automated deployment
|
- automated deployment
|
||||||
- cloud-hosted infrastructure
|
- cloud-hosted infrastructure
|
||||||
- HTTPS certificate management
|
- HTTPS certificate management
|
||||||
- environment-based configuration
|
- environment-based configuration
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
- Create and manage notes
|
- Create and manage notes
|
||||||
- Persistent PostgreSQL database storage
|
- Persistent PostgreSQL database storage
|
||||||
- Responsive modern web interface
|
- Responsive modern web interface
|
||||||
- Dockerized application services
|
- Dockerized application services
|
||||||
- AWS cloud deployment
|
- AWS cloud deployment
|
||||||
- HTTPS secure communication
|
- HTTPS secure communication
|
||||||
- DuckDNS public domain
|
- DuckDNS public domain
|
||||||
- Reverse proxy architecture
|
- Reverse proxy architecture
|
||||||
- Automated deployment scripts
|
- Automated deployment scripts
|
||||||
- Environment variable configuration
|
- Environment variable configuration
|
||||||
- Automatic container restart policies
|
- Automatic container restart policies
|
||||||
- Database backup support
|
- Database backup support
|
||||||
- Access log monitoring
|
- Access log monitoring
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Application Architecture
|
# Application Architecture
|
||||||
|
|
||||||
## High-Level Architecture
|
## High-Level Architecture
|
||||||
|
|
||||||
```text
|
```text
|
||||||
User Browser
|
User Browser
|
||||||
↓
|
↓
|
||||||
NGINX Reverse Proxy (HTTPS)
|
NGINX Reverse Proxy (HTTPS)
|
||||||
↓
|
↓
|
||||||
Flask Backend Container
|
Flask Backend Container
|
||||||
↓
|
↓
|
||||||
PostgreSQL Database Container
|
PostgreSQL Database Container
|
||||||
Loading…
Reference in New Issue
Block a user