Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ViUR base

viur-base provides a basic ViUR project structure.

This is the best place to start a new ViUR 3 project from!


Prerequisites

Before you start, please check out the following prerequisites:

  1. Create a new Google Cloud project here and activate billing
  2. git and python3 with python3-requests is installed
  3. Google Cloud SDK with app-engine-python and app-engine-python-extras components is installed (see here for further help)

Usage

To setup your new ViUR project, check and perform these steps:

  1. git clone https://github.com/viur-framework/viur-base.git YOUR-PROJECT
  2. cd YOUR-PROJECT
  3. ./clean-base.py -A YOUR-APP-ID
  4. ./viur-gcloud-setup.sh YOUR-APP-ID (this step will be improved later!)

You can then start your project locally with ./local_run.sh or deploy it with gcloud app deploy. See the documentation for further help.


Clean git history

It is recommended to clean the git history before you push your new project to a remote git repository. This can easily be done with

$ git checkout --orphan main  # create new orphaned branch with empty history
$ git branch -D master  # remove old viur-base master

Contributing

We take a great interest in your opinion about ViUR. We appreciate your feedback and are looking forward to hear about your ideas. Share your visions or questions with us and participate in ongoing discussions.


Credits

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.


License

Copyright (C) 2012-2021 by Mausbrand Informationssysteme GmbH.

Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.

You may use, modify and distribute this software under the terms and conditions of the GNU Lesser General Public License (LGPL). See the file LICENSE provided within this package for more information.