From 511ab9c77c3b7933c5c74d825ba2624bb0fbc6a4 Mon Sep 17 00:00:00 2001
From: Steve Yonkeu <yokwejuste@yahoo.com>
Date: Tue, 6 Aug 2024 23:00:25 +0000
Subject: [PATCH] docs: adds readme file and documentation

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c14a116
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+## AWS Django Celery Redis using ElasticCache
+
+To run this project you need to have an AWS account and a Redis ElasticCache instance running.
+
+### Steps to run the project:
+
+1. Clone the repository
+2. Create a virtual environment and activate it
+3. Install the requirements
+4. Create a `.env` file with the following command:
+    ```bash
+    cp .env.example .env
+    ```
+5. Fill the `.env` file with your AWS credentials and the Redis ElasticCache endpoint
+6. Run the Django server with the following command:
+    ```bash
+    python manage.py runserver
+    ```
+7. Run the Celery worker with the following command:
+    ```bash
+    celery -A aws_django_celery_redis worker --loglevel=info
+    ```
+## OR
+Run this with docker
+```bash
+docker run -p 8000:8000 <aws_django_celery_redis_image>
+```
+
+## Test Caching and broker
+Go to `http://localhost:8000/add/` to view your task id