{"id":16175419,"url":"https://github.com/app-generator/copier-jinja-demo","last_synced_at":"2025-04-07T11:16:02.247Z","repository":{"id":100502788,"uuid":"332412818","full_name":"app-generator/copier-jinja-demo","owner":"app-generator","description":"Copier Template - Generated Project | AppSeed","archived":false,"fork":false,"pushed_at":"2021-01-24T10:47:55.000Z","size":1589,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T18:12:46.809Z","etag":null,"topics":["appseed","copier-template","flask"],"latest_commit_sha":null,"homepage":"https://copier-jinja.appseed-srv1.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/app-generator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-01-24T09:46:12.000Z","updated_at":"2021-12-13T17:50:13.000Z","dependencies_parsed_at":"2023-05-15T11:15:36.197Z","dependency_job_id":null,"html_url":"https://github.com/app-generator/copier-jinja-demo","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fcopier-jinja-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fcopier-jinja-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fcopier-jinja-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fcopier-jinja-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/copier-jinja-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640468,"owners_count":20971558,"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":["appseed","copier-template","flask"],"created_at":"2024-10-10T04:44:48.607Z","updated_at":"2025-04-07T11:16:02.236Z","avatar_url":"https://github.com/app-generator.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Copier Jinja\n\n\u003e Template project crafted by Sm0ke using Copier generator.\n\n\u003cbr /\u003e\n\n\u003e Features:\n\n- Generator: [Copier](https://github.com/copier-org/copier/)\n- UI Kit: **Pixel Lite** (Free Version) by **Themesberg**\n- Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)\n- Deployment scripts: Docker, Gunicorn/Nginx, HEROKU\n- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).\n\n\u003cbr /\u003e\n\n\u003e Links\n\n- [LIVE Demo](https://copier-jinja.appseed-srv1.com) - starter in action\n- More [Jinja Templates](https://appseed.us/jinja-template) provided by AppSeed\n\n\u003cbr /\u003e\n\n![Copier Template Jinja - Starter provided by AppSeed.](https://raw.githubusercontent.com/app-generator/copier-jinja/master/media/copier-jinja-screen.png)\n\n\u003cbr /\u003e\n\n## Build from sources\n\n```bash\n$ # CD into the root of the project\n$ cd \u003c ROOT_DIRECTORY \u003e\n$\n$ # Virtualenv modules installation (Unix based systems)\n$ virtualenv env\n$ source env/bin/activate\n$\n$ # Virtualenv modules installation (Windows based systems)\n$ # virtualenv env\n$ # .\\env\\Scripts\\activate\n$\n$ # Install requirements\n$ pip3 install -r requirements.txt\n$\n$ # Set the FLASK_APP environment variable\n$ (Unix/Mac) export FLASK_APP=run.py\n$ (Windows) set FLASK_APP=run.py\n$ (Powershell) $env:FLASK_APP = \".\\run.py\"\n$\n$ # Set up the DEBUG environment\n$ # (Unix/Mac) export FLASK_ENV=development\n$ # (Windows) set FLASK_ENV=development\n$ # (Powershell) $env:FLASK_ENV = \"development\"\n$\n$ # Run the Jinja Template\n$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)\n$ # --port=5000    - specify the app port (default 5000)  \n$ flask run --host=0.0.0.0 --port=5000\n$\n$ # Access the UI in browser: http://127.0.0.1:5000/\n```\n\n\u003cbr /\u003e\n\n## Code-base structure\n\nThe project has a simple structure, represented as bellow:\n\n```bash\n\u003c PROJECT ROOT \u003e\n   |\n   |-- app/__init__.py\n   |-- app/\n   |    |-- static/\n   |    |    |-- \u003ccss, JS, images\u003e         # CSS files, Javascripts files\n   |    |\n   |    |-- templates/\n   |    |    |\n   |    |    |-- includes/                 # Page chunks, components\n   |    |    |    |\n   |    |    |    |-- navigation.html      # Top bar\n   |    |    |    |-- sidebar.html         # Left sidebar\n   |    |    |    |-- scripts.html         # JS scripts common to all pages\n   |    |    |    |-- footer.html          # The common footer\n   |    |    |\n   |    |    |-- layouts/                  # App Layouts (the master pages)\n   |    |    |    |\n   |    |    |    |-- base.html            # Used by common pages like index, UI\n   |    |    |    |-- base-fullscreen.html # Used by auth pages (login, register)\n   |    |    |\n   |    |  index.html                      # The default page\n   |    |  login.html                      # Auth Login Page\n   |    |  register.html                   # Auth Registration Page\n   |    |  page-404.html                   # Error 404 page (page not found)\n   |    |  page-500.html                   # Error 500 page (server error)\n   |    |    *.html                        # All other pages provided by the UI Kit\n   |\n   |-- requirements.txt\n   |\n   |-- run.py\n   |\n   |-- ************************************************************************\n```\n\n\u003cbr /\u003e\n\n## Deployment\n\nThe project comes with a basic configuration for [Docker](https://www.docker.com/), [HEROKU](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).\n\n\u003cbr /\u003e\n\n### [Docker](https://www.docker.com/) execution\n---\n\nThe steps to start the template using Docker:\n\n\u003e Get the code\n\n```bash\n$ # CD into the root of the project\n$ cd \u003c ROOT_DIRECTORY \u003e\n```\n\n\u003e Start the app in Docker\n\n```bash\n$ sudo docker-compose pull \u0026\u0026 sudo docker-compose build \u0026\u0026 sudo docker-compose up -d\n```\n\nVisit `http://localhost:5005` in your browser. The app should be up \u0026 running.\n\n\u003cbr /\u003e\n\n### [Heroku](https://www.heroku.com/)\n---\n\nSteps to deploy on **Heroku**\n\n- [Create a FREE account](https://signup.heroku.com/) on Heroku platform\n- [Install the Heroku CLI](https://devcenter.heroku.com/articles/getting-started-with-python#set-up) that match your OS: Mac, Unix or Windows\n- Open a terminal window and authenticate via `heroku login` command\n- Clone the sources and push the project for LIVE deployment\n\n```bash\n$ # CD into the root of the project\n$ cd \u003c ROOT_DIRECTORY \u003e\n$\n$ # Check Heroku CLI is installed\n$ heroku -v\nheroku/7.25.0 win32-x64 node-v12.13.0 # \u003c-- All good\n$\n$ # Check Heroku CLI is installed\n$ heroku login\n$ # this commaond will open a browser window - click the login button (in browser)\n$\n$ # Create the Heroku project\n$ heroku create\n$\n$ # Trigger the LIVE deploy\n$ git push heroku master\n$\n$ # Open the LIVE app in browser\n$ heroku open\n```\n\n\u003cbr /\u003e\n\n### [Gunicorn](https://gunicorn.org/)\n---\n\nGunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.\n\n\u003e Install using pip\n\n```bash\n$ pip install gunicorn\n```\n\u003e Start the app using gunicorn binary\n\n```bash\n$ gunicorn --bind 0.0.0.0:8001 run:app\nServing on http://localhost:8001\n```\n\nVisit `http://localhost:8001` in your browser. The app should be up \u0026 running.\n\n\u003cbr /\u003e\n\n### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)\n---\n\nWaitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.\n\n\u003e Install using pip\n\n```bash\n$ pip install waitress\n```\n\u003e Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)\n\n```bash\n$ waitress-serve --port=8001 run:app\nServing on http://localhost:8001\n```\n\nVisit `http://localhost:8001` in your browser. The app should be up \u0026 running.\n\n\u003cbr /\u003e\n\n## Credits \u0026 Links\n\n- [Flask Framework](https://www.palletsprojects.com/p/flask/) - The official website\n\n\u003cbr /\u003e\n\n---\nCopier Jinja - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fcopier-jinja-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fcopier-jinja-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fcopier-jinja-demo/lists"}