Hello Coders,
This article presents a simple way to build a dashboard seed project in Django using Cookiecutter and AppSeed-Shell, an open-source Python package. All resources mentioned in this article can be downloaded from Github under the MIT License. For newcomers, Cookiecutter creates development-ready
projects from templates.
Thanks for reading! - Content provided by App Generator.
Generated product links:
- Django Bootstrap 5 Volt - LIVE deployment
- Cookiecutter Django - source code
Support - if something goes wrong feel free to ask for support in Discord ππ
How to generated a Django Dashboard
This simple product can be generated in two ways:
β¨1# - AppSeed-Shell package
This library will include more projects once the production-ready
level is reached.
Step #1 - Install π₯
appseed-shell
π₯
$ # Start the application (development mode)
$ pip3 install appseed-shell
Step #2 - Launch the Python shell and generate the product
$ python
>>> from appseed_shell import generate_django
>>> generate_django()
The project is generated in the current working directory. Once is done, please follow the build instructions provided by the README, start the project and create a new user. Only authenticated users can access the private pages.
β¨2# Using Cookiecutter Library
The cookiecutter
tool is executed using the public repository of Cookiecutter Django as first argument
Step #1 - Create a virtual environment
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
Step #2 - Install Modules
$ # Install modules - SQLite Storage
$ pip3 install cookiecutter
Step #3 - Generate the project from Cookiecutter Django
$ cookiecutter https://github.com/app-generator/cookiecutter-django.git
The project is generated in the current working directory.
Roadmap
The CLI interface will be updated soon with more features:
- list all available products (for now is only one)
- For each product the users can choose:
- Database engine: SQLite, PostgreSQL, Mysql, or Mongo
- Add Docker scripts
- Deployment platform: AWS, Google Cloud, HEROKU
In case anyone find this CLI useful, please drop a message in the comments section.
Links & Resources:
- Open-source Dashboards - Flask, Dashboard and React Apps
- Free React Dashboards - a curated list published here on Dev.
Top comments (6)
Looks easy!
ππ Ty!
Documentation is also generated?
Hello, thanks for reading!
The users will have the possibility to choose the docs engine:
ππ
Nice.
I'm using
Docsify
in my projects.ππ