========
Projects
========

Projects are individual websites that run a online shop and other related apps.
Every project is a Django project and consists of multiple Django "apps".
The primary apps for new E-Shop 4.0 projects are all contained in the ``eshop``
python package.

Start a new project
===================

Every project lives in its own repository. They rely on this ``eshop`` package
as their primary dependency. To create a new project for a customer, run
the wizard command::

   $ eshop-startproject

This command will open a site in your browser. Follow the instructions
on the page it will create a project ready for local development.


Prerequisites
-------------

Before you can use the above command, it has to be installed
on your system. You can install the ``eshop`` package from
our internal package server::

   $ pip install --extra-index-url=https://pypi.polynorm.ch/simple --user eshop[dev]


Check out an existing project
=============================

If you're checking out an existing project, you can clone the project as usual.
Then, ensure you have your ~/.pypirc file configured:
https://github.com/polynorm/poly-pypiserver/blob/master/README.md#installing-packages

Now you can run ``make setup`` to set up your local development instance.

This will setup your pipenv and node dependencies as well as build the initial UI code.
It finishes by asking you to create your first superuser.


Create default roles
--------------------

You can load a fixture to create an initial list of
groups for users::

   $ ./manage.py loaddata initial_roles