- App must has a
user boardandadmin board. - App must be designed a easy UI for users to post their confession, with image upload available.
- App must be designed to help Confessions Facebook fan page managers easily manage the contents, automatic schedule and posting to Facebook.
- App must has a communication system for administrators to feedback about the user's confessions and postback their request.
- App must have web push notification system to notice to users that their confessions was approved.
- App must has list & history of all confession, has a clear visual or analyst board of total sent confession and which posted on Facebook.
- App must has a page to fetch all university related articles (crawl) for user to quick view, and also be able to comment on those articles.
- App must be able to run in both Desktop and Mobile web.
- App must be implement a anti-spam system.
- Project Architect is based on scaling
servicesprinciples. - Everything in system is a Docker image (Dockerized), and be able to run on a Kubernetes Cluster (Google Kubernetes Engine with Load Balancer) as
containerswith specificenvironment variables. - How it scale: Google Kubernetes Engine (GKE) Cluster managed, the system will auto scale up or scale down the containers (nodes) to match up with the traffic, due to our configurations.
- Backend implements several services to handle all actions. High performance and slim with Golang.
- Frontend implements with Single Page Application, based
Universal Web Appapproach. Implement a Javascript SDK separated to wrap Service Caller, easy hand-on and maintainance. - Database implemented with MySQL Server (RDBMS) and Google Firebase Database (NoSQL).
- Infrastructure:
- CI/CD integrated with Jenkins: automatic build & deploy after every commit pushed, 100% up time.
- Deployed on a Amazon EC2 VM with Docker eco-system and Nginx.
- Can be deployed on a Container Cluster system (with Kubernetes) if need scaling.
- Server uptime monitor and notice via Slack when down.
- Backend:
Golang(for the high performance)- Pure Go codebase
gorilla-muxfor Routing and Dispatchermemcachedimplement for server-side cachinggoogle/recaptchato implement anti-spam system
- Frontend:
React(for single page application)React 16withreact-router,redux- Pure Node.js
Expressfor Server-side rendering webpackandbabelfor bundle and code chunking- Use
firebase-sdkto implementCloud Message Push Notification - Use
firebase-sdkto implementFirebase Storage for Storing Images
- Javascript SDK for APIs implement:
- Pure
TypeScript axiosfor API callerwebpackfor chunking and bundle
- Pure
- Infrastructure:
DockerCloudflarefor DNS (resolve server IP) and CDN (caching)Dockereco-system, every repos have aDockerfilefor container deploymentNginxfor reverse proxy, resolve services from docker containersJenkinsfor CI/CD integrateAmazon EC2with Ubuntu 18.04 LTS (free-tier package 1GB RAM, 1CPU)Amazon RDSfor SQL serving (free-tier package)- Google
FirebaseSDK for Firebase Database (free package) - Be able to run in a Google Kubernetes Cluster when demo scale (free $300)
Pingdomto monitor uptime service andSlackto push notification
- Git version control with a Github account to access repos
- Go Enviroment v1.2 with GOHOME, GOBIN and
godep - Node.js Environment latest with
yarninstalled - Docker CE latest (Minikube or MiniK8s for Kubernetes Cluster development)
- Visual Studio Code latest (+ ESLint Plugin)
- MySQL Server 5.2 and MySQL Workbench (client)
- Front-end:
Thanh - Back-end & Data:
Tri - Back-end & DevOps:
Tu
- Build up codebase for Backend system:
Tu - Build up codebase for Frontend system:
Thanh - Documenting, visual relation entities, diagrams and documenting:
Tri - Create deployment, build script, infrastructure, Amazon EC2, RDS, Firebase:
Tu - Create domain, DNS to Cloudflare, mapping to Nginx proxy:
Tu - Finalize entities to Database Design:
Tri
- Build and implement APIs for user board, CRUD & Search:
Tu,Tri- Send confess APIs
- Fetch confess APIs
- Search confess APIs
- Build up UI and design forms, apply APIs for user board:
Thanh - Update documents, requirements, diagrams:
Tri - First deploy - monitor CI/CD, server:
Tu
- Build and implement APIs for admin board, CRUD & Search:
Tu,Tri- Approve confess APIs
- Reject confess APIs
- Build up UI and design forms, apply APIs for admin board:
Thanh - Update documents, requirements, diagrams:
Tri
- Restructure codebase for as seperated services:
Tu - Develop UserAPI, ConfessionAPI:
Thanh- Write controller handler
- Write database query with gORM
- Develop UserDMS, ConfessionDMS:
Tri- Write controller handler
- Write database query with gORM
- Develop CrawlWorker, CrawlAPI:
Tu- Write controller handler
- Write database query with gORM
- Develop API Gateway:
Tu
- Uodating and finailize JavaScript SDK:
Tu,Tri- Update finailize environment file with server
- Updating UI and animation:
Thanh- Apply Ant Design JS Animation
- Overall testing:
Tri,Thanh,Tu- Write SDK Unit Test by Jest
- Testing E2E in Chrome/Firefox
- Testing on Mobile/Progressive Web App
- None
- Web App (production): https://fptu.tech (Production for end-users)
- Web App (staging): http://staging.fptu.tech (Support debug by source-map)
- JS SDK Serving Server: https://sdk.fptu.tech/fptu-sdk.js (Static Nginx)
- JSON API Gateway (production): https://api.fptu.tech
- Jenkins CI/CD: https://cicd.fptu.tech
- Grafana analytics and monitoring: https://grafana.fptu.tech/
- AWS EC2 Server: http://54.179.166.164/
- AWS RDS Server: http://dms.cfszgusygva5.ap-southeast-1.rds.amazonaws.com:3306
- EC2 resource usage:
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent