Birthday Wish

This is a simple Django application which will send email to the customer on their birthday

Overview

On customer birthday the system will automatically send email to customer email. Django Rest Framework is used for building api. With api customer info will be store on database and a schedule will be created on customer birthday to send him/her a birthday wish.

CELERY is used for handling schedule/asynchronous job using redis as message broker.

Prerequisites

To get started with this application, you will need to have the following technologies installed on your local machine:

• python3.9 (Mandatory)
• redis (Mandatory)
• postgresql (Not Mandatory)
• Docker (Not Mandatory)
• Docker Compose (Not Mandatory)

Installation

To run the project locally, follow these steps

• Cloning the project

  Open your favourite terminal and run billow commands-

  git clone https://github.com/aninda052/birthday_wish.git
  cd birthday_wish
  

• Creating .env file

  Create a .env file for your environment variable.

   touch .env
  

  You can find the details of all the variables in .env.example file. For running the application just copy billow dummy information and past it to your .env file and save it.

  DEBUG=True
  SECRET_KEY=xy+y*vn5(^^&qp-q5zx@-^@o+v%sw)$y9)o1zskb4y*0khdnaa
  
  CELERY_BROKER_URL=redis://localhost:6379
  CELERY_RESULT_BACKEND=redis://localhost:6379
  
  DATABASE=sqlite
  

• Creating logs directory

  Create logs directory where application logs will be store.

   mkdir logs
  

• Running The Application

  You can run the application in 2 ways

  • Using runserver command

    • Run Django server

        # create a virtual environment using virtualenv
        virtualenv -p python3.9 venv
            
        # Activate virtual environment
        source venv/bin/activate
            
        # Install all required python packages
        pip install -r requirements.txt
            
        # generate database migration files
        python manage.py makemigrations
            
        # migrate new changes on database
        python manage.py migrate --no-input
            
        # create initial superuser
        DJANGO_SUPERUSER_PASSWORD=admin DJANGO_SUPERUSER_USERNAME=admin [email protected] python manage.py createsuperuser --noinput
            
        # run user server at port 8000
        python manage.py runserver 8000
      

    • Run CELERY service

      Open another terminal and run billow command. Make sure you are in your project (birthday_wish) directory and you activate your virtual environment (source venv/bin/activate)

       celery -A birthday_wish worker -B -l info --concurrency 4
      

  • Using docker-compose

    To run the application using docker-compose; docker and docker-compose must be installed on your system. For installation instructions refer to the Docker docs.

    After you installing docker and docker-compose properly, run -

    docker-compose up --build
    

    Note: If the above command run successfully, a initial superuser will be created with username=admin and password=admin.

If everything went well, go to http://127.0.0.1:8000 and you'll find the application up and running.

Api

To add a customer, use billow end point with POST request -

http://localhost:8000/api/add-customer/

Note: Django REST framework provide self describing APIs. So you can just hit the above endpoint from your browser and get the documentation.

• Request Body

  {
      "email" : "[email protected]",
      "date_of_birth": "YYYY-MM-DD",
      "first_name": "customer_first_name",
      "last_name": "customer_last_name"
  }
  

Go to http://127.0.0.1:8000/admin/ and login with your superuser credential to see your customer data along with their birthday schedule.