aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 356636a26f7563ce75e0c2e3420058f962aca5d0 (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
Saleor
======

Avast ye landlubbers! Saleor be a Satchless store ye can fork.

[![Build Status](https://travis-ci.org/mirumee/saleor.png?branch=master)](https://travis-ci.org/mirumee/saleor)


Usage
-----

1. Use `django-admin.py` to start a new project using Saleor as template:

   ```
   $ django-admin.py startproject --template=https://github.com/mirumee/saleor/archive/master.zip myproject
   ```
2. Enter the directory:

   ```
   $ cd myproject/
   ```
3. Install it in development mode:

   ```
   $ python setup.py develop
   ```
   (For production use `python setup.py install` instead.)
4. Prepare the database¹:

   ```
   $ saleor syncdb --all
   ```
5. Run `saleor runserver`¹ to start the development server
6. Edit the code to have it suite your requirements
7. Run the tests to make sure everything works:

   ```
   $ python setup.py test
   ```
8. Deploy!

¹ `saleor` is a shortcut for running `python manage.py` so you can use it to execute all management commands.