Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sellflow/sellflow
A beautiful, customizable open-source mobile app template for your Shopify storefront!
https://github.com/sellflow/sellflow
Last synced: 12 days ago
JSON representation
A beautiful, customizable open-source mobile app template for your Shopify storefront!
- Host: GitHub
- URL: https://github.com/sellflow/sellflow
- Owner: sellflow
- License: mit
- Created: 2020-01-28T03:39:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T10:33:45.000Z (over 2 years ago)
- Last Synced: 2024-05-20T10:51:09.583Z (6 months ago)
- Language: TypeScript
- Homepage: https://sellflow.com
- Size: 4.1 MB
- Stars: 251
- Watchers: 12
- Forks: 80
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
An open-source, pre-built mobile app for your Shopify storefront!
## Features
- 100% [React Native](https://facebook.github.io/react-native/) and [TypeScript](http://typescriptlang.org) built on [Expo](https://expo.io)
- Plugs directly into your existing Shopify store
- Android, iPhone and iPad
- Customizable to your brand's look and feel
- Responsive layout: supports phones and tablets
- Internationalization ready: all strings localized and ready to be translated into your customers' language.
- Free and open source!
- Maintained by a dedicated team
- Commercial support available
## Screenshots
## Getting Started
Prerequisites:
- Make sure you have [Node.js](https://nodejs.org) installed
- Install the latest version of [Expo](https://expo.io/learn)
`npm install --global expo-cli@latest`
- [Recommended] Install [yarn](https://legacy.yarnpkg.com/docs/install)
`curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.21.1`
Note: This will install [v1.x](https://github.com/yarnpkg/yarn/releases) since v2 is not yet compatible with React Native.
- [Get an API key](https://help.shopify.com/en/api/getting-started/authentication/private-authentication#generate-credentials-from-the-shopify-admin) for the Shopify Storefront API for your Shopify store.
Clone the repository:
```sh
git clone [email protected]:sellflow/sellflow.git
cd sellflow
```
Make a file `.env.json` in the root of the project, based on [the example file](https://github.com/sellflow/sellflow/tree/master/.env-example.json). This will contain your Shopify API Key (mentioned above).
```sh
cp .env-example.json .env.json
```
Install dependencies:
```sh
yarn && yarn apollo:generate
```
Run the app:
```sh
yarn start
```
## Background and Motivation
Imagine you’re a store owner and you sell products online using the Shopify platform. Life is good, you have a fantastic website and customers love your products. Shopify provides you with an incredible administrative interface to manage your site’s content, products, pricing, photos, inventory and orders. But you don’t have a native mobile app on iOS or Android!
Customers have asked you about a mobile app but so far you’ve told them to just use the website from their phone. Your web-store is mobile friendly and it works pretty well, but it’s not the true mobile experience your customers expect.
Sellflow is a pre-built mobile app that you can customize to fit your brand and then deploy your own custom mobile commerce app to the Apple App Store or Google Play Store. You can think of it like a “template” that you might use to build your mobile app.
Sellflow is just the “frontend” — the customer interface — it works with Shopify’s “headless mode”, technically the [Storefront API](https://help.shopify.com/en/api/storefront-api). You as the merchant still use Shopify’s admin interface as normal to manage your products, inventory and orders.
## How to Contribute
- Fork the repository.
- Follow the Getting Started instructions above.
- Use your favorite code editor to develop a feature or fix.
- Commit your change to a branch.
- Run the tests:
`yarn test-full`
- Push to your fork and create a PR.
## Professional Support
With official support, you get expert help straight from the core team. We provide dedicated support, prioritize feature requests, deployment strategies, advice on best practices, design decisions, and team augmentation. Reach out to us for consulting at [email protected].
## License
MIT. Copyright (c) [KodeFox, Inc.](https://github.com/kodefox)