Skip to content

Commit

Permalink
docs: adds readme file and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yokwejuste committed Aug 6, 2024
1 parent 1fe9126 commit 511ab9c
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 511ab9c

Please sign in to comment.