CIgen

CIgen is an open-source quizzing software to create and deliver online quizzes, exams, and tests.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• Django
• Docker

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install docker engine and docker compose.

• Docker engine

  https://docs.docker.com/engine/install/
  

• Docker compose

  https://docs.docker.com/compose/install/
  

Installation

1. Clone the repo

   git clone https://github.com//Muhammad-Elgendi/CIgen.git

2. Go to CIgen directory

   cd CIgen/

3. Create your own .env files by copying .env.example

   cp .env.example .env.dev
   cp .env.example .env.prod

4. Go to docker directory

   cd CIgen/docker

5. Create your own .env file for docker compose by copying .env.example

   cp .env.example .env

6. Create and start all the containers

   docker-compose up

7. Generate a new security key

8. Creating a New Administrator Account

   docker-compose exec web bash
   python manage.py createsuperuser

9. Fill out your credentials

10. Open a new browser tab and Visit localhost:8000

Use Cases

CIgen could be used for different use cases, here are some examples:

1. Quiz maker software
2. Attendance management software

Additional screenshots, screencasts, and more resources will be soon.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL-3.0 license. See LICENSE for more information.

Contact

Muhammad Elgendi- @gendidev

Project Link: https://github.com//Muhammad-Elgendi/CIgen