This is a documentation for the Django Ad Campaign Manager project. The project is designed to manage advertising campaigns and is divided into two major components: the backend, which utilizes Django Rest Framework (DRF) and drf-yasg for API documentation, and the frontend, built with Next.js and Tailwind CSS.
The project is organized into two distinct folders:
-
Backend
- This folder contains all the server-side logic of the application.
- It utilizes Django as the web framework and Django Rest Framework for creating RESTful APIs.
- API documentation is generated using drf-yasg.
- To get started with the backend, navigate to the
backend
directory and refer to its own README for setup instructions.
-
Frontend
- The frontend of the application is implemented using Next.js, a React framework for server-rendered applications.
- Tailwind CSS is used for styling to ensure a responsive and user-friendly interface.
- For details on setting up and running the frontend, please go to the
frontend
directory and consult the accompanying README.
To set up and run the Django Ad Campaign Manager, follow these general steps:
- Navigate to the
backend
folder. - Create a virtual environment and activate it.
- Install the required Python packages using
pip install -r requirements.txt
. - Perform database migrations using
python manage.py migrate
. - Create a superuser account with
python manage.py createsuperuser
. - Start the development server with
python manage.py runserver
. - Access the API documentation at
/swagger/
or/redoc/
in your web browser.
- Go to the
frontend
folder. - Install Node.js and npm if not already installed.
- Install the required Node.js packages with
npm install
. - Start the development server with
npm run dev
. - Access the frontend application in your web browser.
- The Django Ad Campaign Manager allows you to create, manage, and analyze advertising campaigns.
- Detailed usage instructions for both the backend and frontend can be found in their respective README files.
- We welcome contributions to this project. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTING.md file.
- This project is licensed under the MIT License.
For any questions or inquiries, please contact:
michael Adawaren voke hudskings@gmail.com