suliman-99/Marketing-System

Just a small app for an interview test

Marketing System

View Demo · Report Bug · Request Feature

---

Table of Contents

• Introduction
• Tech Stack
• Prerequisites
• Installation
• Project stucture
• Contributing
• Contact
• License

Introduction

this is just a small marketing app requested for an interview task

API Documentation Can Be Found on the blank url after the domain 'http://127.0.0.1:8000/'

Tech Stack

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

Prerequisites

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed.

• Python - Download & Install Python

• MySQL - Download & Install MySQL

• pipenv module:

  after you install python you will have pip installed on your machin automatically you can check it by

      pip --version
  

Installation

first open cmd in the place you want to download the project in then write this commands :

1. Clone the repository to your local machine:

   git clone https://github.com/suliman-99/marketing-system.git
   

2. Navigate to the project directory:

   cd Marketing-System/Django_Backend
   

3. then to install pipenv module by pip just write this command on your cmd

   pip install pipenv
   

4. Install the required dependencies using pipenv:

   pipenv install
   

5. Activate the pipenv:

   pipenv shell
   

6. Create the .env file in "Marketing-System/Django_Backend" folder with this data:

   SECRET_KEY = 'You can get this key by https://djecrety.ir/'
   DATABASE_NAME = 'create a database and put its name here'
   DATABASE_HOST = 'localhost'
   DATABASE_USER = 'user'
   DATABASE_PASSWORD = 'user password'
   

7. Migrate the database tables and Run the project:

   • Windows:

     python manage.py migrate
     python manage.py runserver
     

   • Linux or Mac:

     python3 manage.py migrate
     python3 manage.py runserver
     

Project stucture

Project Name
│   README.md
└───Django_Backend
│   │   manage.py
│   └───Django_Backend
│   │   
│   └───Marketing_System
│   
└───docs
    │   ERD.png
    │   UseCase_Diagram.png
    │   Marketing_System.mdj

• Django_Backend A Folder Conatain the backend django apps
• Django_Backend/Django_Backend A Folder Conatain the the settings of the backend project
• Django_Backend/Marketing_System the one and only app in the backend project
• docs a Folder Contains the diagrams that explain the system requirments
• docs/Marketing_System.mdj this is the file of the diagrams with StarUML program (windows app)

Contributing

If you have suggestions for how Marketing System could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Contact

Suliman Awad - sulimanawadstudy@gmail.com - Linkedin

Project Link: https://github.com/suliman-99/marketing-system

License

MIT License

Copyright (c) 2023 Suliman Awad

For more, check out the License File.