{"id":13710034,"url":"https://github.com/viur-framework/viur-base","last_synced_at":"2025-04-13T17:31:03.600Z","repository":{"id":38960965,"uuid":"92827804","full_name":"viur-framework/viur-base","owner":"viur-framework","description":"ViUR base project template - Start here with your new ViUR project!","archived":false,"fork":false,"pushed_at":"2025-02-26T21:53:45.000Z","size":3746,"stargazers_count":13,"open_issues_count":6,"forks_count":11,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-11T19:58:00.202Z","etag":null,"topics":["appengine-python","framework","getting-started","jinja2","python","template","viur"],"latest_commit_sha":null,"homepage":"https://www.viur.dev","language":"Less","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/viur-framework.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":"2017-05-30T11:53:15.000Z","updated_at":"2025-02-26T21:51:29.000Z","dependencies_parsed_at":"2023-02-13T21:16:59.646Z","dependency_job_id":"9e728046-3533-47f4-b892-6713b70857a2","html_url":"https://github.com/viur-framework/viur-base","commit_stats":null,"previous_names":[],"tags_count":13,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viur-framework","download_url":"https://codeload.github.com/viur-framework/viur-base/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248752346,"owners_count":21156076,"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":["appengine-python","framework","getting-started","jinja2","python","template","viur"],"created_at":"2024-08-02T23:00:50.999Z","updated_at":"2025-04-13T17:31:03.168Z","avatar_url":"https://github.com/viur-framework.png","language":"Less","readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-base.svg\" height=\"196\" alt=\"A hexagonal logo of the viur-base\" title=\"viur-base\"\u003e\n    \u003ch1\u003eviur-base\u003c/h1\u003e\n    \u003cbr\u003e\n    This is the place to start your new \u003ca href=\"https://www.viur.dev\"\u003eViUR\u003c/a\u003e project from!\n\u003c/div\u003e\n\n## About\n\n`viur-base` is a template for new ViUR projects and already comes with a default setting to quickly start coding.\u003cbr\u003e\nThe repository is intended to serve as a template, therefore feel free to remove any stuff from it to fit your specific\nproject demands.\n\n## Requirements\n\nBefore you start, please check out the following preliminaries are met:\n\n1. You either need Linux, macOS, or Windows with WSL.\n    See [awesome-viur](https://awesome.viur.dev/README#tutorials--examples) for further help and information for specific operating systems.\n2. `git`, `python`, `pyenv` and `pipenv` should be installed\n    You can use any Python version \u003e= 3.10 with ViUR, we recommend Python 3.11 currently.\n3. install [Google Cloud SDK](https://cloud.google.com/sdk/docs/install) and the required components with the following commands\n    ```\n    gcloud components update\n    gcloud components install app-engine-python app-engine-python-extras\n    gcloud auth application-default login\n    ```\n    or (see [here](https://core.docs.viur.dev/en/stable/doc_start/index.html#prerequisites) for further help)\n\n## Usage\n\n1. Create a new Google Cloud project [here](https://console.cloud.google.com/projectcreate) and activate billing.\n\n    \u003e We will refer to the name of the project you created as `YOUR-APP-ID`.\n2. Clone this repository with `git clone https://github.com/viur-framework/viur-base.git YOUR-PROJECT`.\n\n    \u003e This creates a new local folder `YOUR-PROJECT`. In most cases, `YOUR-PROJECT` and `YOUR-APP-ID` should be identical.\n3. `cd YOUR-PROJECT`\n4. `./clean-base.py -A YOUR-APP-ID`\n5. `./viur-gcloud-setup.sh YOUR-APP-ID`\n6. Install local development dependencies with `pipenv install --dev`\n7. Locally run your project with `pipenv run viur run` or deploy it with `pipenv run viur deploy app`. Run a `pipenv shell` to work with the [viur-cli](https://github.com/viur-framework/viur-cli) command line tool.\n\nSee the [documentation](https://viur-core.readthedocs.io/en/latest/doc_start/index.html) for further help.\n\n## Contributing\n\nViUR is developed and maintained by [Mausbrand Informationssysteme GmbH](https://www.mausbrand.de/en), from Dortmund in Germany. We are a software company consisting of young, enthusiastic software developers, designers and social media experts, working on exciting projects for different kinds of customers. All of our newer projects are implemented with ViUR, from tiny web-pages to huge company intranets with hundreds of users.\n\nHelp of any kind to extend and improve or enhance this project in any kind or way is always appreciated.\n\nWe take great interest in your opinion about ViUR. We appreciate your feedback and are looking forward to hear about your ideas. Share your vision or questions with us and participate in ongoing discussions.\n\n## License\n\nCopyright © 2024 by Mausbrand Informationssysteme GmbH.\u003cbr\u003e\nMausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.\n\nLicensed under the MIT license. See LICENSE for more information.\n","funding_links":[],"categories":["Official ViUR Resources"],"sub_categories":["Main Repositories"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviur-framework%2Fviur-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviur-framework%2Fviur-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviur-framework%2Fviur-base/lists"}