Refine README and week 1 documentation
This commit is contained in:
@@ -1,34 +1,20 @@
|
|||||||
|
```markdown
|
||||||
# Scalable Task Platform
|
# Scalable Task Platform
|
||||||
|
|
||||||
An end-to-end DevOps project that shows how a task application can be containerized, deployed, automated, scaled, and monitored using Docker, GitHub Actions, Terraform, Kubernetes, Prometheus, and Grafana.
|
An end-to-end DevOps project that shows how a task application can be containerized, automated, deployed, scaled, and monitored.
|
||||||
|
|
||||||
## Project Overview
|
## Stack
|
||||||
|
|
||||||
This repository documents the step-by-step development of a scalable task platform designed to reflect real DevOps workflows. The project starts from a simple backend service and will grow into a fully containerized, automated, cloud-ready, and observable platform.
|
- Node.js
|
||||||
|
- Express
|
||||||
|
- Docker
|
||||||
|
- GitHub Actions
|
||||||
|
- Terraform
|
||||||
|
- Kubernetes
|
||||||
|
- Prometheus
|
||||||
|
- Grafana
|
||||||
|
|
||||||
The goal is not just to build a task application, but to demonstrate how modern DevOps practices are applied across the full software delivery lifecycle.
|
## Roadmap
|
||||||
|
|
||||||
## What This Project Demonstrates
|
|
||||||
|
|
||||||
- Containerization with Docker
|
|
||||||
- Continuous Integration and Delivery with GitHub Actions
|
|
||||||
- Infrastructure provisioning with Terraform
|
|
||||||
- Kubernetes-based orchestration
|
|
||||||
- Monitoring and observability with Prometheus and Grafana
|
|
||||||
- Progressive project documentation through weekly implementation updates
|
|
||||||
|
|
||||||
## Planned Stack
|
|
||||||
|
|
||||||
- Backend: Node.js + Express
|
|
||||||
- Frontend: to be added
|
|
||||||
- Database: PostgreSQL
|
|
||||||
- Containerization: Docker
|
|
||||||
- CI/CD: GitHub Actions
|
|
||||||
- Infrastructure: Terraform
|
|
||||||
- Orchestration: Kubernetes
|
|
||||||
- Monitoring: Prometheus and Grafana
|
|
||||||
|
|
||||||
## Project Roadmap
|
|
||||||
|
|
||||||
- [Week 1: Project foundation and backend setup](docs/week-1-update.md)
|
- [Week 1: Project foundation and backend setup](docs/week-1-update.md)
|
||||||
- Week 2: Dockerize the backend
|
- Week 2: Dockerize the backend
|
||||||
@@ -39,25 +25,10 @@ The goal is not just to build a task application, but to demonstrate how modern
|
|||||||
- Week 7: Cloud deployment
|
- Week 7: Cloud deployment
|
||||||
- Week 8: Kubernetes deployment
|
- Week 8: Kubernetes deployment
|
||||||
- Week 9: Monitoring with Prometheus and Grafana
|
- Week 9: Monitoring with Prometheus and Grafana
|
||||||
- Week 10: Hardening, documentation, and portfolio polish
|
- Week 10: Hardening and project polish
|
||||||
|
|
||||||
## Current Status
|
## Current Status
|
||||||
|
|
||||||
Week 1: Project foundation in progress
|
- Week 1 completed
|
||||||
|
- Backend validated locally
|
||||||
## Weekly Updates
|
- Ready for Week 2
|
||||||
|
|
||||||
Project progress will be documented week by week in the `docs` folder.
|
|
||||||
|
|
||||||
- [Week 1 Update](docs/week-1-update.md)
|
|
||||||
|
|
||||||
## Repository Structure
|
|
||||||
|
|
||||||
```text
|
|
||||||
scalable-task-platform/
|
|
||||||
├── app/
|
|
||||||
│ ├── backend/
|
|
||||||
│ └── frontend/
|
|
||||||
├── docs/
|
|
||||||
│ └── week-1-update.md
|
|
||||||
└── README.md
|
|
||||||
+51
-10
@@ -1,14 +1,55 @@
|
|||||||
# Week 1 Update
|
# Week 1 — Project Foundation and Backend Setup
|
||||||
|
|
||||||
## Project Objective
|
1. Install Node.js and restart your computer
|
||||||
Build a production-style scalable task platform that will grow step by step with Docker, CI/CD, Terraform, Kubernetes, and monitoring.
|
|
||||||
|
|
||||||
## Progress So Far
|
2. Verify installation
|
||||||
- Created GitHub repository
|
|
||||||
- Cloned repository locally
|
`node -v`
|
||||||
- Opened project in VS Code
|
`npm.cmd -v`
|
||||||
- Created initial project structure
|
|
||||||
- Created backend starter files
|
3. Create `app/backend`, `app/frontend`, and `docs`
|
||||||
|
|
||||||
|
4. Create `server.js` and `package.json` inside the backend folder
|
||||||
|
|
||||||
|
5. Create and update project documentation:
|
||||||
|
- `README.md`
|
||||||
|
- `docs/week-1-update.md`
|
||||||
|
|
||||||
|
6. Install dependencies
|
||||||
|
|
||||||
|
`cd app\backend`
|
||||||
|
`npm.cmd install`
|
||||||
|
|
||||||
|
This creates:
|
||||||
|
- `node_modules/`
|
||||||
|
- `package-lock.json`
|
||||||
|
|
||||||
|
7. Start the server
|
||||||
|
|
||||||
|
`node server.js`
|
||||||
|
|
||||||
|
You should see:
|
||||||
|
|
||||||
|
`Server running on port 3000`
|
||||||
|
|
||||||
|
8. Test the API — open in your browser
|
||||||
|
|
||||||
|
`http://localhost:3000`
|
||||||
|
`http://localhost:3000/health`
|
||||||
|
|
||||||
|
You should see:
|
||||||
|
- `/` → `Task backend is running`
|
||||||
|
- `/health` → `{"status":"healthy"}`
|
||||||
|
|
||||||
|
## Outcome
|
||||||
|
|
||||||
|
✅ Node.js installed successfully
|
||||||
|
✅ Project structure created
|
||||||
|
✅ Backend files created
|
||||||
|
✅ Dependencies installed
|
||||||
|
✅ Backend working locally
|
||||||
|
✅ Health endpoint returning healthy response
|
||||||
|
|
||||||
## Next Step
|
## Next Step
|
||||||
Run the backend locally before containerizing it
|
|
||||||
|
Week 2: Dockerize the backend service
|
||||||
Reference in New Issue
Block a user