https://github.com/mr-mudgal/referral-system-task

This project is a Django-powered Referral System App that streamlines user registration and referral tracking with ease. Whether it’s onboarding new users or managing referral-based rewards, this application provides a robust and efficient solution.
https://github.com/mr-mudgal/referral-system-task

django django-application django-framework django-project django-rest-framework mysql object-relational-mapping orm orm-framework python3 rest-api restful-api sqlite3

Last synced: 7 days ago
JSON representation

This project is a Django-powered Referral System App that streamlines user registration and referral tracking with ease. Whether it’s onboarding new users or managing referral-based rewards, this application provides a robust and efficient solution.

• Host: GitHub
• URL: https://github.com/mr-mudgal/referral-system-task
• Owner: mr-mudgal
• Created: 2024-04-09T12:00:55.000Z (10 months ago)
• Default Branch: master-mudgal
• Last Pushed: 2025-01-15T17:45:35.000Z (23 days ago)
• Last Synced: 2025-01-15T20:05:07.553Z (23 days ago)
• Topics: django, django-application, django-framework, django-project, django-rest-framework, mysql, object-relational-mapping, orm, orm-framework, python3, rest-api, restful-api, sqlite3
• Language: Python
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
How to execute and run the Django Application with docker?

- Note: The Django application is Dockerized using Dockerfile and Docker Compose.

- Open terminal in the root directory of the project, where Dockerfile and manage.py file exists.

- Execute the following command 'docker-compose up' to start the container.

- If the container doesn't start or display some error, execute command 'docker-compose build' and wait until the built is over, then execute 'docker-compose up' again and it would work fine now.

- When successfully started, open browser and go to http://localhost:8000

How to execute and run the Django Application without Docker?

- Make sure you have all the dependencies installed as mentioned in requirements.txt. To install all at once execute command 'pip -r requirements.txt'.

- Open the terminal and execute the following command: 'python manage.py runserver'

- Then go to browser and open http://localhost:8000

Few Snapshots:









Points to Remember:

- Django Application contain only one app userRegistration.

- Unit Tests for Django apps are written in sub-directories inside tests directory.

- db.sqlite3 is our database file and manage.py is our entry point file.

- forms.py inside userRegistration directory is the form for registration.

- models.py inside userRegistration directory contains the database schema for the user.

- urls.py inside userRegistration directory contains all the API endpoints which can be used for different functinality over the website. Comments are written beside it and in their respective view function to know what API and view function does what.

- views.py inside userRegistration directory contains all the logical function which are being used all over the userRegistration app and API endpoints.

- templates sub-directory inside userRegistration directory contains html file to be rendered when some API endpoint is being called.

For any query raise issue or comment in the repository.

Thank You

coded by: {Rishabh Mudgal}