Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 3.12 KB

README.md

File metadata and controls

52 lines (35 loc) · 3.12 KB
Raw
A hexagonal logo of the viur-base

viur-base


This is the best place to start a 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 >= 3.10 and pipenv should be installed
  3. Google Cloud SDK with app-engine-python and app-engine-python-extras components (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 © 2023 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.