From fa92a9882eaac97b3b13270ad3b6001cc3ee0a54 Mon Sep 17 00:00:00 2001
From: Anson <58594437+AnsonDev42@users.noreply.github.com>
Date: Thu, 25 Apr 2024 16:26:27 +0100
Subject: [PATCH] Update README.md (#12)

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3a437a1..fe27f7f 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,45 @@ This repo is the back-end implementation of the following project.
 ---
 
 ###  Demo
-Click [here](https://uptime-monitor-front.pages.dev)
+Click [here](https://uptime-monitor-front.pages.dev) to see for yourself
+
+![image](https://github.com/AnsonDev42/uptime-monitor-front/assets/58594437/9a119264-49b8-4f08-9810-6198456b27ad)
+![image](https://github.com/AnsonDev42/uptime-monitor-front/assets/58594437/308529f3-e8f4-4f96-85e6-f845e572c603)
+
+
+
+---
+
+### Running / Building PART1/2 (for front-end)
+Installing Bun (the front-end package manager): https://bun.sh/
+- Install dependencies(only need to run once) : `bun install`
+- Run for development: `bun run dev`
+- Build for production: `bun build`
+
+Fork [frontend](https://github.com/AnsonDev42/uptime-monitor-front) and you can easily deploy it for free in [Cloudflare Page](https://pages.cloudflare.com/), [Vercel](https://vercel.com/) and etc.
+
+---
+
+### Running / Building PART2/2 Method1 **RECOMMENDED** (for backend-end)
+
+Installing [Docker and Docker-compose](https://docs.docker.com/compose/install/)
+- modify your configration in `docker-compose.yml` file if needed
+- copy the `.env.dev` to `.env`, modify in `.env`
+- docker-compose up
+
+---
+
+### Running / Building PART2/2: Method2 (for backend-end)
+Installing [peotry](https://python-poetry.org/) (the back-end package manager for python):
+- copy the `.env.dev` to `.env`, modify in `.env`
+- Install dependencies(only need to run once) : `poetry install`
+- Install and run both postgresDB **and** rabbitMQ
+- In one shell to run Django Server: `./manage.py runserver`
+- In another new shell to run celery server: `celery -A uptimemonitor worker --loglevel=INFO`
+- In another new shell to run celery-beat: `celery -A uptimemonitor beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler`
+  
+
+
 
 ---