Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ghaithheni/easydjango

EasyDjango is a command-line tool for quickly setting up a new Django project with customizable options, including app creation, templates, static files, and superuser setup.
https://github.com/ghaithheni/easydjango

automation automation-scripts django django-framework pypi pypi-package python

Last synced: 19 days ago
JSON representation

EasyDjango is a command-line tool for quickly setting up a new Django project with customizable options, including app creation, templates, static files, and superuser setup.

Awesome Lists containing this project

README

        

# Easy Django Project Setup Tool

EasyDjango is a command-line tool for quickly setting up a new Django project with customizable options, including app creation, templates, static files, and superuser setup.

[**Click here for a Demo**](#usage)

## Features

- Create a new Django project and app with minimal commands.
- Optionally include Tailwind CSS for styling (by adding the argument `--tailwind`).
- Automatic creation of necessary directories for templates, static files, and media.
- Create a superuser during setup.
- Colorful and user-friendly CLI prompts.

## Installation

You can install QuickDjango via pip. First, ensure you have Python and pip installed, then run:

```bash
pip install easydjango-project
```

> **Note**: The installation command is the same for Windows, macOS, and Linux, but you might need to use pip3 instead on some operating systems.

## Usage

To create a new Django project, execute the following easy command:

```bash
easydjango
```

You will be prompted to provide the following information:

Project Name (default: `myproject`)
App Name (default: `myapp`)
Superuser Username (default: `admin`)
Superuser Password (default: `admin`)

## Demonstration

![Usage Example](https://github.com/ghaithheni/easydjango/blob/main/EasyDjango%20Example.gif?raw=true)

## Contributing

If you'd like to contribute to EasyDjango, feel free to fork the repository and submit a pull request. Any contributions are welcome!

## License

This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.

## Acknowledgements

Django for being an awesome web framework.
Colorama for colorful terminal text.

## Contact

For inquiries or feedback, please reach out at [[email protected]](mailto:[email protected]).