Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/viur-framework/viur-base

ViUR base project template - Start here with your new ViUR project!
https://github.com/viur-framework/viur-base

appengine-python framework getting-started jinja2 python template viur

Last synced: about 2 months ago
JSON representation

ViUR base project template - Start here with your new ViUR project!

Host: GitHub
URL: https://github.com/viur-framework/viur-base
Owner: viur-framework
License: mit
Created: 2017-05-30T11:53:15.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-08-28T18:23:08.000Z (4 months ago)
Last Synced: 2024-08-28T20:06:50.647Z (4 months ago)
Topics: appengine-python, framework, getting-started, jinja2, python, template, viur
Language: Less
Homepage: https://www.viur.dev
Size: 3.48 MB
Stars: 12
Watchers: 10
Forks: 12
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-viur - ViUR-Base - Start a new ViUR Project by cloning from this template (Official ViUR Resources / Main Repositories)

README

viur-base

This is the place to start your new ViUR project from!

## About

`viur-base` is a template for new ViUR projects and already comes with a default setting to quickly start coding.

The repository is intended to serve as a template, therefore feel free to remove any stuff from it to fit your specific
project demands.

## Requirements

Before you start, please check out the following preliminaries are met:

1. You either need Linux, macOS, or Windows with WSL.
See [awesome-viur](https://awesome.viur.dev/README#tutorials--examples) for further help and information for specific operating systems.
2. `git`, `python`, `pyenv` and `pipenv` should be installed
You can use any Python version >= 3.10 with ViUR, we recommend Python 3.11 currently.
3. install [Google Cloud SDK](https://cloud.google.com/sdk/docs/install) and the required components with the following commands
```
gcloud components update
gcloud components install app-engine-python app-engine-python-extras
gcloud auth application-default login
```
or (see [here](https://core.docs.viur.dev/en/stable/doc_start/index.html#prerequisites) for further help)

## Usage

1. Create a new Google Cloud project [here](https://console.cloud.google.com/projectcreate) and activate billing.

> We will refer to the name of the project you created as `YOUR-APP-ID`.
2. Clone this repository with `git clone https://github.com/viur-framework/viur-base.git YOUR-PROJECT`.

> This creates a new local folder `YOUR-PROJECT`. In most cases, `YOUR-PROJECT` and `YOUR-APP-ID` should be identical.
3. `cd YOUR-PROJECT`
4. `./clean-base.py -A YOUR-APP-ID`
5. `./viur-gcloud-setup.sh YOUR-APP-ID`
6. Install local development dependencies with `pipenv install --dev`
7. 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.

See the [documentation](https://viur-core.readthedocs.io/en/latest/doc_start/index.html) for further help.

## Contributing

ViUR 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.

Help of any kind to extend and improve or enhance this project in any kind or way is always appreciated.

We 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.

## License

Licensed under the MIT license. See LICENSE for more information.