Update readme
This commit is contained in:
dominik-zeglen
parent
f8c62f3bb9
commit
80371c0c56
1 changed files with 16 additions and 136 deletions
152
README.md
152
README.md
|
|
@ -1,143 +1,23 @@
|
||||||
|
### Before you do anything
|
||||||
|
|
||||||
<div align="center">
|
Run following command to install dependencies:
|
||||||
<h1>Saleor</h1>
|
`npm i`
|
||||||
</div>
|
|
||||||
|
|
||||||
<div align="center">
|
### Configuration
|
||||||
<strong>E-commerce for the PWA era</strong>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div align="center">
|
You'll need to set `APP_MOUNT_URI` and `API_URI` environment variables.
|
||||||
A modular, high performance e-commerce storefront built with GraphQL, Django, and ReactJS.
|
Example:
|
||||||
</div>
|
`APP_MOUNT_URI=/` and `API_URI=http://localhost:8000/graphql/` will mount
|
||||||
|
dashboard at `localhost:9000/` and set API URI to `http://localhost:8000/graphql/`.
|
||||||
|
This is default config if you start Saleor at port 8000. Setting `APP_MOUNT_URI`
|
||||||
|
to `/dashboard/` will mount app at `localhost:9000/dashboard/`.
|
||||||
|
|
||||||
<br>
|
### Development
|
||||||
|
|
||||||
<div align="center">
|
Start development server by running following command:
|
||||||
Join our active, engaged community: <br>
|
`npm start`
|
||||||
<a href="https://getsaleor.com/">Website</a>
|
|
||||||
<span> | </span>
|
|
||||||
<a href="https://medium.com/saleor">Blog</a>
|
|
||||||
<span> | </span>
|
|
||||||
<a href="https://twitter.com/getsaleor">Twitter</a>
|
|
||||||
<span> | </span>
|
|
||||||
<a href="https://gitter.im/mirumee/saleor">Gitter</a>
|
|
||||||
<span> | </span>
|
|
||||||
<a href="https://spectrum.chat/saleor">Spectrum</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<br>
|
### Production
|
||||||
|
|
||||||
<div align="center">
|
Build application bundle by running following command:
|
||||||
<a href="https://circleci.com/gh/mirumee/saleor">
|
`npm run build`
|
||||||
<img src="https://circleci.com/gh/mirumee/saleor.svg?style=svg" alt="Build status" />
|
|
||||||
</a>
|
|
||||||
<a href="http://codecov.io/github/mirumee/saleor?branch=master">
|
|
||||||
<img src="http://codecov.io/github/mirumee/saleor/coverage.svg?branch=master" alt="Codecov" />
|
|
||||||
</a>
|
|
||||||
<a href="https://docs.getsaleor.com/en/latest/?badge=latest">
|
|
||||||
<img src="https://readthedocs.org/projects/saleor/badge/?version=latest" alt="Documentation Status" />
|
|
||||||
</a>
|
|
||||||
<a href="https://github.com/python/black">
|
|
||||||
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
- [What makes Saleor special?](#what-makes-saleor-special)
|
|
||||||
- [Features](#features)
|
|
||||||
- [Installation](#installation)
|
|
||||||
- [Demo](#demo)
|
|
||||||
- [Contributing](#contributing)
|
|
||||||
- [Translations](#translations)
|
|
||||||
- [Your feedback](#your-feedback)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
|
|
||||||
## What makes Saleor special?
|
|
||||||
|
|
||||||
Saleor is a rapidly-growing open source e-commerce platform that has served high-volume companies from branches like publishing and apparel since 2012. Based on Python and Django, the latest major update introduces a modular front end powered by a GraphQL API and written with React and TypeScript.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
- __PWA__: End users can shop offline for better sales and shopping experiences
|
|
||||||
- __GraphQL API__: Access all data from any web or mobile client using the latest technology
|
|
||||||
- __Headless commerce__: Build mobile apps, customize storefronts and externalize processes
|
|
||||||
- __UX and UI__: Designed for a user experience that rivals even the top commercial platforms
|
|
||||||
- __Dashboard__: Administrators have total control of users, processes and products
|
|
||||||
- __Orders__: A comprehensive system for orders, dispatch and refunds
|
|
||||||
- __Cart__: Advanced payment and tax options, with full control over discounts and promotions
|
|
||||||
- __Payments__: Flexible API architecture allows integration of any payment method. Comes with Braintree support out of the box.
|
|
||||||
- __Geo-adaptive__: Automatic localized pricing. Over 20 local languages. Localized checkout experience by country.
|
|
||||||
- __SEO__: Packed with features that get stores to a wider audience
|
|
||||||
- __Cloud__: Optimized for deployments using Docker
|
|
||||||
- __Analytics__: Server-side Google Analytics to report e-commerce metrics without affecting privacy
|
|
||||||
|
|
||||||
Saleor is free and always will be.
|
|
||||||
Help us out… If you love free stuff and great software, give us a star! 🌟
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Saleor requires Python 3.6+, Node.js 10.0+, PostgreSQL and OS-specific dependency tools.
|
|
||||||
|
|
||||||
[See the Saleor docs](https://saleor.readthedocs.io) for step-by-step installation and deployment instructions.
|
|
||||||
|
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
Want to see Saleor in action?
|
|
||||||
|
|
||||||
[View Storefront](http://demo.getsaleor.com/) | [View Dashboard (admin area)](http://demo.getsaleor.com/dashboard/)
|
|
||||||
|
|
||||||
Or launch the demo on a free Heroku instance.
|
|
||||||
|
|
||||||
[](https://heroku.com/deploy)
|
|
||||||
|
|
||||||
Login credentials: `admin@example.com`/`admin`
|
|
||||||
|
|
||||||
|
|
||||||
## PWA Storefront
|
|
||||||
The PWA, single-page storefront lives in a [separate repository](https://github.com/mirumee/saleor-storefront).
|
|
||||||
|
|
||||||
[View PWA Storefront](https://pwa.getsaleor.com/)
|
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
We love your contributions and do our best to provide you with mentorship and support. If you are looking for an issue to tackle, take a look at issues labelled [`Help Wanted`](https://github.com/mirumee/saleor/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
|
|
||||||
|
|
||||||
If nothing grabs your attention, check [our roadmap](https://github.com/mirumee/saleor/projects/6) or come up with your own feature. Just drop us a line or [open an issue](https://github.com/mirumee/saleor/issues/new) and we’ll work out how to handle it.
|
|
||||||
|
|
||||||
Get more details in our [Contributing Guide](https://saleor.readthedocs.io/en/latest/contributing.html).
|
|
||||||
|
|
||||||
|
|
||||||
## Translations
|
|
||||||
|
|
||||||
Did you know that Saleor is available in almost 30 languages, translated entirely by our community?
|
|
||||||
|
|
||||||
If you'd like to help us, you can join one of our translation teams on [the localization platform Transifex](https://www.transifex.com/mirumee/saleor-1/languages/).
|
|
||||||
|
|
||||||
The repository gets synchronized weekly with the latest contributions.
|
|
||||||
|
|
||||||
|
|
||||||
## Your feedback
|
|
||||||
|
|
||||||
Do you use Saleor as an e-commerce platform?
|
|
||||||
Fill out this short survey and help us grow. It will take just a minute, but mean a lot!
|
|
||||||
|
|
||||||
[Take a survey](https://mirumee.typeform.com/to/sOIJbJ)
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Disclaimer: Everything you see here is open and free to use as long as you comply with the [license](https://github.com/mirumee/saleor/blob/master/LICENSE). There are no hidden charges. We promise to do our best to fix bugs and improve the code.
|
|
||||||
|
|
||||||
Some situations do call for extra code; we can cover exotic use cases or build you a custom e-commerce appliance.
|
|
||||||
|
|
||||||
|
|
||||||
#### Crafted with ❤️ by [Mirumee Software](http://mirumee.com)
|
|
||||||
hello@mirumee.com
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue