msisdn-app-api

MSISDN App API

Project Description: This is a Django application with two main API's: a user API and an international phone number (MSISD) API. The MSISD API connects to a postgres database. The frontend allows a user to enter an MSISDN (Mobile Station International Subscriber Directory Number) as input and returns associated information, including:

• MNO (Mobile Network Operator) identifier
• country dialing code
• subscriber number and
• country identifier (ISO 3166-1-alpha-2)

When entering in a number that is not already in the database, the field information is parsed automatically and the entry is added to the database.

Project requirements

Technologies used:

• git 2.32.1
• Docker v24.0.6
• Docker-compose v2.20.2

Running this project locally requires installation of Docker Desktop.
Since development is all done through Docker, there are no other local installations needed.

Getting started with local development

Obtain above installations.

In the termninal navigate to a place you would like to clone this repository.
Run git clone https://github.com/dmdequin/msisdn-app-api.git
Navigate to the root directory of the project: cd msisdn-app-api

To build the app in development run docker-compose build. This will build the docker image while using the docker-compose.yml file.

Run Project with Docker

After building the docker image, run: docker-compose up Then go to http://localhost:8000/api/msisd/home/ to access the MSISD API home page.

To test admin functionality go to: http://localhost:8000/admin.
Create a superuser in the terminal by entering docker-compose run --rm app sh -c "python manage.py createsuperuser
Then login to the admin page using the admin credentials you provided.

Prometheus was set up for monitoring and can be viewed at http://localhost:9090.

Swagger is used in this project to generate a documentation page for the API. This can be accessed at http://localhost:8000/api/docs. The documentation shows all of the API endpoints, and you can test the html actions available for each such as POST or GET.

Linting and Testing Locally

Automated testing and linting was configured using GitHub Actions. This is completed after each push to the remote repository.

This project uses Flake8 for code linting. To run linting, from the main project directory enter: docker-compose run --rm app sh -c "flake8"

This project contains unit tests that test each of the apps (user and msisd). To run the tests locally enter the following from the main project directory: docker-compose run --rm app sh -c "python manage.py test".

Locally running the deployed version of the app

The deployed app can be run locally for testing. To do so:

• In the root directory of the project create a file named '.env'. Here copy the contents of the .env.sample file.
• Go to line 37 in the docker-compose-deploy.yml file and change the port mapping for the proxy to 8000:8000 (it is currently set to 80:8000).
• Enter the proxy directory and run docker build . to build the docker image there.
• Go back to the main directory and run docker-compose -f docker-compose-deploy.yml build.
• Then run docker-compose -f docker-compose-deploy.yml up to run the application.
• In the browser go to http://127.0.0.1:8000/api/docs and test out the various endpoints using the Swagger documentation page.

Deployed App

The deployed app was hosted on an AWS EC2 instance.