You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+28-24
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,16 @@
13
13
- Modern & Open Platform for **On-Demand Economy**
14
14
- Supports Single-Store and Multi-Store / Multi-Vendor / Peer-to-Peer Marketplaces
15
15
- Everything Reactive, Real-Time and Blazing Fast!
16
-
- Headless Commerce framework, which allows different implementations of store-fronts, Admin UIs and client apps. Exposes rich GraphQL, REST and WS APIs.
16
+
- Headless Commerce framework, which allows different implementations of store-fronts, Admin UIs and client apps. It exposes rich GraphQL, REST and WS APIs.
17
17
- Mobile ordering App for customers to make On-Demand orders (Hybrid / PWA, iOS and Android using Ionic / Ionic Native)
18
18
- Carrier (Driver) Mobile App for deliveries by carriers, drivers or service providers (iOS and Android using Ionic / Ionic Native)
19
19
- Customizing Shopping e-commerce Website for customers to make in-browser On-Demand purchases of food, goods or services
20
20
- Merchant Tablet App for Stores/Merchants/Warehouses to manage & track orders, organize deliveries, etc.
21
21
- Admin Website used to manage all platform features and settings in the single Web-based interface
22
-
- Multi-language and culture settings accross Platform (i18N)
22
+
- Multi-language and culture settings across Platform (i18N)
23
23
- Products Catalogs (global and per Merchant) with Multiple Product Images
24
-
- Inventory/Stock Management and Real-time Order Management/Processing accross the Platform
25
-
- Deliveries/Shipping management and processing accross Platform (shipping with real-time location tracking for On-Demand orders)
24
+
- Inventory/Stock Management and Real-time Order Management/Processing across the Platform
25
+
- Deliveries/Shipping management and processing across Platform (shipping with real-time location tracking for On-Demand orders)
26
26
- Real-Time discounts, promotions and products/services availability updates
- Large products catalogs with products variants, facets and full-text search
37
37
38
38
You can also track feature requests from the community in the [separate repo](https://github.com/ever-co/feature-requests/issues).
@@ -62,23 +62,27 @@ Expect _lots_ of changes and some :bug: and please be nice! :stuck_out_tongue_wi
62
62
63
63
Please refer to our official [Platform Documentation](https://docs.ever.co) and to our [Wiki](https://github.com/ever-co/ever/wiki) (WIP).
64
64
65
-
For quick overview of each project in the Platform (Server, Admin, Shops, etc), you can search for README.md file in the root of the projects folders. For example, see [./backend/api/README.md](backend/api/README.md) for Server (Backend) related overview.
65
+
For a quick overview of each project in the Platform (Server, Admin, Shops, etc.), you can search for README.md file in the root of the projects folders. For example, see [./backend/api/README.md](backend/api/README.md) for Server (Backend) related overview.
66
66
67
67
## Getting Started
68
68
69
-
We follow [Gitflow Workflow](https://nvie.com/posts/a-successful-git-branching-model) so the [`develop` branch](https://github.com/ever-co/ever/tree/develop) may be in an unstable or even broken state during development. Please use [releases](https://github.com/ever-co/ever/releases) or [`master` branch](https://github.com/ever-co/ever/tree/master) instead of the `develop` branch in order to get more stable code.
69
+
We follow [Gitflow Workflow](https://nvie.com/posts/a-successful-git-branching-model), so the [`develop` branch](https://github.com/ever-co/ever/tree/develop) may be in an unstable or even broken state during development. Please use [releases](https://github.com/ever-co/ever/releases) or [`master` branch](https://github.com/ever-co/ever/tree/master) instead of the `develop` branch in order to get more stable code.
Note: it's important to enable Git symlinks because they are used for shared modules (every project have symlinks to common shared modules in the /shared folder)
79
+
Notes:
80
+
81
+
- if you want to use development branch (unstable, but latest development) clone using `--branch develop`
82
+
- it's necessary to enable Git symlinks because they used for shared modules (every project has symlinks to shared modules in the /shared folder)
83
+
- because of symlinks, you may need to clone from an elevated command prompt (on Windows)
80
84
81
-
If you use Git >= v2.14, it probably make sense to setup following globally:
85
+
If you use Git >= v2.14, it probably makes sense to setup following globally:
82
86
83
87
```
84
88
git config --global core.symlinks true
@@ -93,28 +97,28 @@ Notes:
93
97
94
98
### Yarn
95
99
96
-
Currently we are using `Yarn` (instead of `npm`), so make sure you have latest Yarn version installed before running Ever Platform:
100
+
Currently, we are using `Yarn` (instead of `npm`), so make sure you have latest Yarn version installed before running Ever Platform:
97
101
98
102
```
99
103
npm install -g yarn@latest
100
104
```
101
105
102
106
### Quick installation
103
107
104
-
After git repo is cloned, just run following command to install/bootstrap all dependencies:
108
+
After git repo cloned, just run following command to install/bootstrap all dependencies:
105
109
106
110
```
107
111
yarn bootstrap
108
112
```
109
113
110
-
This will install required packages in all Platform projects using Lerna
114
+
Above command install required packages in all Platform projects using Lerna.
111
115
112
116
Note: if above command fails for any reason, you can try to install required packages manually by running `yarn` inside every sub-folder with 'package.json' file
113
117
114
118
### Lerna (manual installation)
115
119
116
120
We are using [Lerna](https://github.com/lerna/lerna) for mono-repo management.
117
-
You need to run the following command from working folder where you cloned Ever git repo, which will install Lerna together with other packages:
121
+
You need to run the following command from the working folder where you cloned Ever git repo, which install Lerna together with other packages:
118
122
119
123
```
120
124
yarn
@@ -132,19 +136,19 @@ Now, after Lerna installed (locally or globally), you need to Bootstrap all depe
132
136
yarn lerna bootstrap
133
137
```
134
138
135
-
The command above will install all required packages for every sub-project of the Ever Platform.
139
+
The command above install all required packages for every sub-project of the Ever Platform.
136
140
137
141
### MongoDB
138
142
139
-
Ever platform configured to use MongoDB by default and assume you have MongoDB service running and accepting connections on default `localhost:27017`. Please see relevant section in our [documentation](https://github.com/ever-co/ever/wiki/MongoDB).
143
+
Ever platform configured to use MongoDB by default and assume you have MongoDB service running and accepting connections on the default `localhost:27017`. Please see relevant section in our [documentation](https://github.com/ever-co/ever/wiki/MongoDB).
140
144
141
145
### Platform Configuration
142
146
143
147
See relevant section in our [documentation](https://github.com/ever-co/ever/wiki/Ever-Platform-Configuration).
144
148
145
149
### Run Platform Projects
146
150
147
-
Finally, each project from Ever Platform can be started by single command from this list:
151
+
Finally, each project from Ever Platform could start by single command from this list:
148
152
149
153
```
150
154
yarn run:server # Run API server
@@ -155,7 +159,7 @@ Finally, each project from Ever Platform can be started by single command from t
155
159
yarn run:carrier # Run Carrier Mobile app
156
160
```
157
161
158
-
Note: on the first run, API Server (Backend) will create MongoDB local database `ever_development` with the following (default) Admin user
162
+
Note: on the first run, API Server (Backend) creates MongoDB local database `ever_development` with the following (default) Admin user
@@ -164,11 +168,11 @@ You can use credentials above to login into Platform Admin App, which available
164
168
165
169
## Metrics
166
170
167
-
According to [cloc](https://github.com/AlDanial/cloc) project, Ever Platform today has more than 120K lines of TypeScript, GraphQL, HTML / CSS and other code files. You can get more details at the relevant section of our [documentation](https://github.com/ever-co/ever/wiki/Metrics).
171
+
According to [cloc](https://github.com/AlDanial/cloc) project, Ever Platform today has more than 120K lines of TypeScript, GraphQL, HTML / CSS and other code files. You can get more details in the relevant section of our [documentation](https://github.com/ever-co/ever/wiki/Metrics).
168
172
169
173
## Contribute
170
174
171
-
- Please give us :star: on Github, it **really** helps!
175
+
- Please give us :star: on Github, it **helps**!
172
176
- You are more than welcome to submit feature requests in the [separate repo](https://github.com/ever-co/feature-requests/issues)
173
177
- Pull requests are always welcome! Please base pull requests against the _develop_ branch and follow the [contributing guide](.github/CONTRIBUTING.md).
174
178
@@ -215,11 +219,11 @@ Ever Platform follows good security practices, but 100% security cannot be guara
215
219
Ever Platform is provided AS IS without any warranty. Use at your own risk!
216
220
See more details in the [LICENSE.md](LICENSE.md).
217
221
218
-
In production setup, all client-side to server-side (backend, APIs) communications should be encrypted using HTTPS/WSS/SSL (REST APIs, GraphQL endpoint, Socket.io WebSockets, etc).
222
+
In a production setup, all client-side to server-side (backend, APIs) communications should be encrypted using HTTPS/WSS/SSL (REST APIs, GraphQL endpoint, Socket.io WebSockets, etc.).
219
223
220
224
## License
221
225
222
-
This software is available under different licenses
226
+
This software is available under different licenses.
223
227
224
228
### _Ever Platform Community Edition_ License
225
229
@@ -240,9 +244,9 @@ You should have received a copy of the relevant GNU Licenses along with this pro
240
244
241
245
### _Ever Platform Enterprise_ License
242
246
243
-
Alternatively, commercial versions of the software must be used in accordance with the terms and conditions of separate written agreement between you and Ever Co. LTD.
247
+
Alternatively, commercial versions of the software must be used in accordance with the terms and conditions of a separate written agreement between you and Ever Co. LTD.
244
248
245
-
For more information about Ever® Platform Enterprise™ License please contact <mailto:[email protected]>.
249
+
For more information about Ever® Platform Enterprise™ License, please contact <mailto:[email protected]>.
246
250
247
251
#### The default Ever® Platform™ license, without a valid Ever® Platform Enterprise™ License agreement, is the Ever® Platform Community™ Edition License.
0 commit comments