{"id":18463708,"url":"https://github.com/alvii147/boilerplate","last_synced_at":"2026-05-08T01:42:35.567Z","repository":{"id":134303505,"uuid":"324052365","full_name":"alvii147/Boilerplate","owner":"alvii147","description":"Scripts to create boilerplate code under different frameworks","archived":false,"fork":false,"pushed_at":"2022-10-02T21:52:16.000Z","size":2396,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-16T16:57:57.625Z","etag":null,"topics":["django","flask","pyqt5"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alvii147.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-24T03:05:20.000Z","updated_at":"2022-03-24T16:32:45.000Z","dependencies_parsed_at":"2023-03-25T20:02:22.643Z","dependency_job_id":null,"html_url":"https://github.com/alvii147/Boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvii147%2FBoilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvii147%2FBoilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvii147%2FBoilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alvii147%2FBoilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alvii147","download_url":"https://codeload.github.com/alvii147/Boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251320001,"owners_count":21570488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","flask","pyqt5"],"created_at":"2024-11-06T09:07:43.948Z","updated_at":"2026-05-08T01:42:30.523Z","avatar_url":"https://github.com/alvii147.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate code generator\n\n`createboilerplate.sh` is a bash script for generating boilerplate code for projects based on specific libraries and frameworks. It's intended to help kickstart projects by laying out the empty templates and take over the repetitive task of setting initial configurations.\n\n## Supported Libraries \u0026 Frameworks\n\n- [Django](#django)\n- [Go (Web Server)](#go)\n- [Flask](#flask)\n- [PyQt6](#pyqt6)\n\n## Getting Started\n\nClone the repository to your local environment.\n\n```bash\ngit clone https://github.com/alvii147/Boilerplate.git\n```\n\nIt's convenient to set up an alias for the path to this script so it can be called from anywhere. Add the following line to `.bashrc` or `.bashprofile` to set up a permanent alias.\n\n```bash\nalias createboilerplate=\"/absolute/path/to/./createboilerplate.sh\"\n```\n\nThere are some dependencies within the individual projects, all of which are explored below.\n\n## Django\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"img/django_logo.png\" alt=\"Django logo\" width=\"300\"/\u003e\u003c/p\u003e\n\n### Usage\n\n```\ncreateboilerplate [OPTIONS] django\n```\n\n### Options\n\n```\n-p = project name\n```\n\n### Requirements\n\nInstall Django, Django REST Framework, and Django CORS Headers.\n\n```bash\npip3 install django djangorestframework django-cors-headers\n```\n\n### Example Use\n\n```\ncreateboilerplate -p MyProject django\n```\n\nThis creates a [Django](https://www.djangoproject.com/) project and application. The application includes development and production settings, and an `accounts` app with a custom user model.\n\n```\nMyProject/\n├── MyProject\n│   ├── __init__.py\n│   ├── asgi.py\n│   ├── settings\n│   │   ├── __init__.py\n│   │   ├── base.py\n│   │   ├── dev.py\n│   │   └── prod.py\n│   ├── urls.py\n│   └── wsgi.py\n├── accounts\n│   ├── __init__.py\n│   ├── admin.py\n│   ├── apps.py\n│   ├── migrations\n│   │   └── __init__.py\n│   ├── models.py\n│   ├── tests.py\n│   └── views.py\n└── manage.py\n```\n\nTo start using the application, set the appropriate environment variables.\n\n```bash\n# development/production environment\nexport MYPROJECT_DJANGO_ENV=\"\u003cenvironment\u003e\"\n# secret key\nexport MYPROJECT_DJANGO_SECRET_KEY=\"\u003csecret key\u003e\"\n# postgres settings\nexport MYPROJECT_POSTGRES_DB=\"\u003cpostgresql database name\u003e\"\nexport MYPROJECT_POSTGRES_USER=\"\u003cpostgresql username\u003e\"\nexport MYPROJECT_POSTGRES_PASSWORD=\"\u003cpostgres password\u003e\"\nexport MYPROJECT_POSTGRES_HOST=\"\u003cpostgres host name\u003e\"\nexport MYPROJECT_POSTGRES_PORT=\"\u003cpostgres port number\u003e\"\n# email backend settings (only for production)\nexport MYPROJECT_EMAIL_HOST_USER=\"\u003chost email address\u003e\"\nexport MYPROJECT_EMAIL_HOST_PASSWORD=\"\u003chost email password\u003e\"\n```\n\nOnce environment variables are set, Django server is ready to be run.\n\n```bash\npython3 manage.py runserver\n```\n\nIn order to create and apply initial migrations (include those of the custom user), run migrations command.\n\n```bash\npython3 manage.py makemigrations\npython3 manage.py migrate\n```\n\n## Flask\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"img/flask_logo.png\" alt=\"Flask logo\" width=\"300\"/\u003e\u003c/p\u003e\n\n### Usage\n\n```\ncreateboilerplate [OPTIONS] flask\n```\n\n### Options\n\n```\n-p = project name\n```\n\n### Requirements\n\nInstall Flask and Flask SQLAlchemy.\n\n```bash\npip3 install Flask Flask-SQLAlchemy\n```\n\nInstall Flask SQLAlchemy (optional, required for setup database option).\n\n```\npip install flask-sqlalchemy\n```\n\n### Example Use\n\n```\ncreateboilerplate -p MyProject flask\n```\n\nThis creates a boilerplate Python [Flask](https://flask.palletsprojects.com/) application, with an HTML template, a CSS file and a SQLite3 database.\n\n```\nMyProject/\n├── MyProject.py\n├── static\n│   └── styles.css\n└── templates\n    └── home.html\n```\n\nSet up environment variables.\n\n```bash\nexport FLASK_APP_SECRET_KEY=\"\u003csecret key\u003e\" \n```\n\nExecuting `MyProject.py` runs the basic Flask application on `https://localhost:5000`.\n\n```bash\npython3 MyProject.py\n```\n\n![Flask Screenshot](img/flask_screenshot.png)\n\n## Go\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"img/go_logo.png\" alt=\"Go logo\" width=\"300\"/\u003e\u003c/p\u003e\n\n### Usage\n\n```\ncreateboilerplate [OPTIONS] go\n```\n\n### Options\n\n```\n-p = project name\n-u = github username\n```\n\n### Requirements\n\nInstall Go from the [official Go website](https://go.dev/)\n\n### Example Use\n\n```\ncreateboilerplate -p MyProject -u Noobmaster69 go\n```\n\nThis generates a boilerplate Go server that serves HTML templates using [Go's built-in templating library](https://pkg.go.dev/html/template), styled with [Bootstrap](https://getbootstrap.com/). A `Dockerfile` is also generated to build and run the application inside a [Docker](https://www.docker.com/) container.\n\n```\nMyProject/\n├── Dockerfile\n├── go.mod\n├── handlers\n│   ├── home.go\n│   ├── logging.go\n│   └── templates.go\n├── main.go\n├── static\n│   ├── css\n│   │   └── styles.css\n│   ├── images\n│   │   └── gopher.png\n│   └── js\n│       └── index.js\n└── templates\n    ├── head.html\n    ├── home.html\n    ├── navbar.html\n    └── scripts.html\n```\n\nExecute the go module to run the web server on `https://localhost:8000`.\n\n```bash\ngo run .\n```\n\n![Go Screenshot](img/go_screenshot.png)\n\n## PyQt6\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"img/qt_logo.png\" alt=\"Qt logo\" width=\"300\"/\u003e\u003c/p\u003e\n\n### Usage\n\n```\ncreateboilerplate [OPTIONS] pyqt6\n```\n\n### Options\n\n```\n-p = project name\n```\n\n### Requirements\n\nInstall PyQt6.\n\n```\npip install pyqt6\n```\n\n### Example Use\n\n```\ncreateboilerplate -p MyProject pyqt6\n```\n\nThis creates a boilerplate [PyQt5](https://riverbankcomputing.com/software/pyqt/intro) script, `MyProject.py`. Running it starts a basic PyQt6 desktop application.\n\n```\npython3 MyProject.py\n```\n\n![PyQt6 Screenshot](img/pyqt6_screenshot.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvii147%2Fboilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falvii147%2Fboilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falvii147%2Fboilerplate/lists"}