Skip to content

Commit

Permalink
Update README.md (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
AnsonDev42 authored Apr 25, 2024
1 parent abfe947 commit fa92a98
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`




---

Expand Down

0 comments on commit fa92a98

Please sign in to comment.