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 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 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 for further help)

Usage

1. Create a new Google Cloud project here 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 command line tool.

See the documentation for further help.

Contributing

ViUR is developed and maintained by Mausbrand Informationssysteme GmbH, 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

Copyright © 2024 by Mausbrand Informationssysteme GmbH.
Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.

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