The following instructions assume a 64-bit installation of Windows.
Before you are ready to run Saleor, you will need additional software installed on your computer.
Download the latest 3.7 Windows installer from the Python download page and follow the installation steps.
Make sure that “Add Python 3.7 to PATH” is selected.
Saleor requires version 10 or later. Download the Windows installer from Node.js downloads page.
Make sure that “Add to PATH” is selected.
Saleor needs PostgreSQL version 9.4 or above to work. Get the Windows installer from the project’s download page.
Make a note of the password you set for the administration account during the installation process.
Download and install the 64-bit Windows installer.
Make sure that “*Set up PATH environment variable to include GTK+” is selected.
Download and install the latest version of the Build Tools for Visual Studio.
Once you have installed or updated the pre-requisite software, you are ready to install Saleor. Follow the steps below to start and execute the process:
All commands need to be performed in either PowerShell or a Command Shell.
1. Clone the repository (replace the URL with your own fork where needed)
git clone https://github.com/mirumee/saleor.git
2. Enter the directory
3. Install all dependencies
We strongly recommend creating a virtual environment before installing any Python packages.
python -m pip install -r requirements.txt
SECRET_KEY environment variable
We try to provide usable default values for all the settings. We have 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.
env:SECRET_KEY = "<mysecretkey>"
The secret key should be a unique string that only your team knows. Running the code with a known
SECRET_KEYdefeats many of Django’s security protections. It can also lead to privilege escalation and remote code execution vulnerabilities. Consult Django’s documentation for details.
5. Create a PostgreSQL user
Use the pgAdmin tool that comes with your PostgreSQL installation to create a database user for your store.
Unless configured otherwise, the store will use
saleor as both the username and password. Remember to assign your user the
SUPERUSER privilege. This will allow you to create databases and database extensions.
6. Create a PostgreSQL database
See PostgreSQL’s createdb command for details.
The database name is extracted from the
DATABASE_URLenvironment variable. If absent, it defaults to
7. Prepare the database
python manage.py migrate
This command creates database extensions. If you get an error related to the
CREATE EXTENSIONcommand, please return to the instructions in the PostgreSQL user creation step.
8. Install front-end dependencies
If this step fails, make sure you are using a recent version of Node.js.
9. Prepare front-end assets
npm run build-assets
10. Compile e-mails
npm run build-emails
11. Start the development server:
python manage.py runserver