Skip to content

Commit b70be0e

Browse files
authored
Update README.md
1 parent d2f8129 commit b70be0e

1 file changed

Lines changed: 66 additions & 1 deletion

File tree

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,66 @@
1-
# WooCommerceMobile
1+
# WooCommerceMobile
2+
3+
Flutter mobile WooCommerce application for your customers.
4+
5+
## Server requirements
6+
7+
`//ToDo: add requirements`
8+
9+
## Build instructions
10+
11+
In order to build the app, you need to create the `.env` file in project root directory, with the necessary variables.
12+
13+
Here is the example of `.env` file:
14+
15+
```.env
16+
# Base URL for the WooCommerce REST API
17+
WOO_BASE_URL = https://woocommerce.store/wp-json/wc/v3/
18+
19+
# Base URL for the CoCart REST API
20+
CO_CART_BASE_URL = https://woocommerce.store/wp-json/cocart/v2/
21+
22+
# Base URL for the WordPress REST API
23+
WP_BASE_URL = https://woocommerce.store/wp-json/
24+
25+
# WooCommerce API Public token
26+
AUTH_PUBLIC_TOKEN = (( SOME TOKEN STRING HERE ))
27+
28+
# WooCommerce API Secret token
29+
AUTH_SECRET_TOKEN = (( SOME TOKEN STRING HERE ))
30+
31+
# CoCart API Public token
32+
CO_CART_PUBLIC_TOKEN = (( SOME TOKEN STRING HERE ))
33+
34+
# CoCart API Secret token
35+
CO_CART_SECRET_TOKEN = (( SOME TOKEN STRING HERE ))
36+
37+
```
38+
39+
For the security reasons do not commit or share with anyone content of this file. For this repo `.env` file is added to `.gitignore`.
40+
41+
After that you can build the app using your local flutter environment (Android Studio, VS Code, or just execute `flutter build` / `flutter run` in console).
42+
43+
## Available languages
44+
45+
User interface of the app is translated for languages listed below:
46+
47+
- English
48+
- Українська
49+
- Русский
50+
51+
Any contributions to the translations are welcome.
52+
53+
## License
54+
55+
This license of the software is opensource, but contains some restrictions.
56+
57+
- The software is provided `as is` and may contain some issues.
58+
- Commercial usage of this app and any fork that is based on this app is not allowed without author permission.
59+
- Distribution of this app and any fork that is based on this app to any public store (like Google Play, App Store, F-Droid) is not allowed without author permission.
60+
- Every fork that is based on this app should contain original copyright UI section.
61+
62+
Full license agreement is available [here](https://1.cc).
63+
64+
## Maintainers
65+
66+
- Dmitriy Moroz / dmitriy@moroz.cc

0 commit comments

Comments
 (0)