blob: 13a196f2c98fd9d3c44d6d49761125d1e4b3ee97 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
Getting started
===============
.. note::
If you prefer using containers or have problems with configuring PostgreSQL, Redis and Elasticsearch, try :ref:`docker_dev` instructions.
Prerequisites
-------------
Before you are ready to run Saleor you will need certain software installed on your computer.
#. `Python <https://www.python.org/>`_ version 3.5.x or 2.7.x
#. `pip <https://pip.pypa.io/en/stable/installing/>`_ if you're using an older release of Python 2.7
#. ``wheel`` Python package if you're using pip older than 8.1.2
#. `Node.js <https://nodejs.org/>`_ version 6 or above
.. note::
Debian and Ubuntu users who install Node.js using system packages will also need to install the ``nodejs-legacy`` package.
#. `webpack module bundler <https://webpack.github.io/>`_ installed globally with:
.. code-block:: bash
$ npm i webpack -g
#. `Yarn <https://yarnpkg.com/>`_ installed globally with:
.. code-block:: bash
$ npm i yarn -g
#. `PostgreSQL <https://www.postgresql.org/>`_ version 9.4 or above
We also strongly recommend creating a virtual environment before proceeding with installation.
Installation
------------
#. Clone the repository (or use your own fork):
.. code-block:: bash
$ git clone https://github.com/mirumee/saleor.git
#. Enter the directory:
.. code-block:: bash
$ cd saleor/
#. Install all dependencies:
.. code-block:: bash
$ pip install -r requirements.txt
#. Set ``SECRET_KEY`` environment variable.
.. note::
Secret key should be a unique string only your team knows.
It's serious as this key is used to ensure security of your installation.
Consult `Django's documentation <https://docs.djangoproject.com/en/1.10/ref/settings/#secret-key>`_ for details.
We try to provide usable default values for all of the settings.
We've decided not to provide a default for ``SECRET_KEY`` as we fear someone would inevitably ship a project with the default value left in code.
.. code-block:: bash
$ export SECRET_KEY='<mysecretkey>'
#. Create PostgreSQL user:
.. note::
You need to create the user to use within your project.
Username and password are extracted from ``DATABASE_URL`` environmental variable.
If absent, defaults to ``saleor`` and ``saleor``.
Consult `PostgreSQL's documentation <https://www.postgresql.org/docs/current/static/app-createuser.html>`_ for details.
#. Prepare the database:
.. code-block:: bash
$ python manage.py migrate
#. Install front-end dependencies:
.. code-block:: bash
$ yarn
.. note::
If this step fails go back and make sure you're using new enough version of Node.js.
#. Prepare front-end assets:
.. code-block:: bash
$ yarn run build-assets
#. Run like a normal django project:
.. code-block:: bash
$ python manage.py runserver
Example data
------------
If you'd like some data to test your new storefront you can populate the database with example products and orders:
.. code-block:: bash
$ python manage.py populatedb
|
