Welcome to the Certify Certificate Generator, an open-source project built using the Django web framework. This application is designed to be user-friendly and easy to use, allowing users to create customized certificates. It provides functionality to generate certificates in bulk and send them via email. This README file provides an overview of the project, detailed installation instructions, usage guidelines, and other relevant information.
-
Customizable Certificate Creation: The application allows users to create customized certificates using templates and customizable fields such as participant name, event title, date, and more. Users can select from various fonts, colors, and designs to match their preferences. The application also supports uploading custom certificate templates.
-
Bulk Certificate Generation: Users can generate multiple certificates in bulk by uploading a CSV file containing participant data. The application automatically populates the certificate templates with the corresponding participant information, saving time and effort. The CSV file should have headers that match the template fields.
-
Email Integration: The application includes email integration, enabling users to send generated certificates directly to participants via email. Users can customize the email template and include personalized messages or additional attachments. The email settings can be configured in the Django settings file.
-
User Management: The application provides user management features, allowing administrators to create and manage user accounts. User roles and permissions can be assigned to control access to the certificate generation and bulk email functionality. The admin panel can be accessed at
/admin. -
Template Library: Users can create and manage a library of certificate templates for easy access and reuse. Templates can be categorized, edited, and deleted as needed. The application supports uploading custom templates in HTML format.
-
Customization Options: The application offers a range of customization options, including fonts, colors, alignment, and size, to create visually appealing and professional-looking certificates. These options can be configured in the template editor.
To run the Django Certificate Generator locally, follow these detailed steps:
-
Clone the repository:
git clone https://github.com/TadashiJei/Certify.git
-
Navigate to the project directory:
cd Certify -
(Recommended) Create and activate a virtual environment: It is highly recommended to use a virtual environment to isolate the project's dependencies.
python3 -m venv venv source venv/bin/activate # On macOS and Linux # venv\Scripts\activate # On Windows
-
Install the required dependencies:
pip install -r requirements.txt
-
Set up the database: Apply the database migrations to create the necessary tables.
python manage.py migrate
-
Create a superuser: Create a superuser account to access the admin panel.
python manage.py createsuperuser
Follow the prompts to create your superuser account.
-
Start the development server:
python manage.py runserver
-
Access the application: Open a web browser and access the application at
http://localhost:8000. You can log in to the admin panel athttp://localhost:8000/adminusing the superuser credentials you created.
Note: Make sure you have Python and Django installed on your system before proceeding with the above steps. You can install Django using pip install django.
Once the application is running, users can register an account or log in with their existing credentials. After authentication, users can create customized certificates by selecting a template, filling in the required fields, and applying desired styles.
For bulk certificate generation, users can upload a CSV file containing participant data and select a template to automatically generate certificates for all participants. The application provides options to review and modify the generated certificates before finalizing the process. The CSV file should have headers that match the template fields.
Users can also utilize the email integration feature to send the generated certificates directly to participants via email. Customization options for the email template and attachments are available in the admin panel.
Contributions to the Django Certificate Generator are welcome! If you find any issues or have suggestions for improvement, please create a new issue in the project's GitHub repository. You can also submit pull requests with bug fixes, new features, or enhancements.
Before contributing, please follow these guidelines:
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them with clear and concise messages.
- Submit a pull request to the
mainbranch. - Ensure your code adheres to the project's coding standards and best practices.
The Django Certificate Generator is released under the MIT License. You can find more details in the LICENSE file included with the project.
The Django Certificate Generator is built using the Django web framework and various open-source libraries, including:
- Django: The web framework used to build the application.
- Bootstrap: The CSS framework used for styling.
- Font Awesome: The icon library used in the application.
- jQuery: The JavaScript library used for DOM manipulation.
We would like to acknowledge the contributions of the Django community and the developers behind these libraries. Their hard work and dedication make projects like this possible.