Ever - Open-Source On-Demand Commerce Platform

Ever® is an Open-Source, Real-Time, Reactive, On-Demand Commerce Platform build with TypeScript.

Out-of-the-box Ever® Platform™ provides everything required to quickly build, manage and expand Multi-Store (Multi-Vendor Marketplace) or Single-Store On-Demand Commerce Solutions with customized e-commerce Websites (shops), Mobile ordering apps (Hybrid and PWA), Carrier (Driver) apps, Merchant apps and Admin interface website.

Disclaimer

A word of caution: We are in α (alpha), i.e. Ever® Platform™ is very much under development (work in progress, WIP).
Expect lots of changes and some 🐛 and please be nice! 😜

Features

Open Platform (every part is Open-Source)
Everything Reactive, Real-Time and Blazing Fast!
Headless Commerce framework, which allows different implementations of store-fronts, Admin UIs and client apps. Exposes rich GraphQL, REST and WS APIs.
Shopping Mobile App for customers to make On-Demand orders (iOS and Android using Ionic / Ionic Native)
Carrier Mobile App for carriers, drivers or delivery service providers (iOS and Android using Ionic / Ionic Native)
Shopping e-commerce Website for customers to make in-browser On-Demand purchases of food, goods or services
Merchant Tablet App used by Stores/Merchants/Warehouses to manage & track orders, organize deliveries, etc.
Admin Website used to manage all platform features and settings in the single Web-based interface
Multi-language and culture settings accross Platform (i18N)
Products Catalogs (global and per Merchant) with Multiple Product Images
Inventory/Stock Management and Real-time Order Management/Processing accross the Platform
Deliveries/Shipping management and processing accross Platform (shipping with real-time location tracking for On-Demand orders)
Real-Time discounts, promotions and products/services availability updates
Customers registration, Guest Checkouts, Invitations (optional)
Gateway and Payment Processing (currently supported Payments Gateway - Stripe)
Plugins / Extensions / Custom Fields (WIP)

Planned Features

Tax Calculations
Third-party Shipping providers integrations
Users Roles / Permissions accross Platform
Large products catalogs with products variants, facets and full-text search

You can also track feature requests from the community in the separate repo.

Technology Stack and Requirements

TypeScript language (version >=2.9)
Node.js (version >=10)
Ionic (version 4) for Shopping Mobile App, Carrier Mobile App and Merchant Tablet App
Shopping Website developed with Angular 7 using Angular Starter
Admin Website developed with Angular version 7 using ngx-admin
Headless Commerce framework (Backend APIs/Server) developed using Nest with heavy use of our own Pyro module. Supports GraphQL, REST and WS Real-Time APIs (WebSockets using Socket.io library)
RxJS library used heavy in every part of the Platform
InversifyJS used for Inversion Control / Dependency Injection in most parts of the Platform. On the Backend/API we also use DI provided by Nest
MongoDB Database used with Mongoose ORM (supported MongoDB version >= 3.2; we recommend version >=4)
We have ongoing effort (WIP) to add support for other databases using TypeORM and Prisma. Following additional DBs will be fully supported: MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server and Oracle.
For production, we integrate and recommend to use PM2

Documentation

Please refer to https://docs.ever.co for the Platform Documentation (WIP)

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 for Server (Backend) related overview.

Getting Started

Clone Repo

Clone the Ever Platform Git repo:

git clone -c core.symlinks=true --recursive git@github.com:ever-co/ever.git

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)

If you use Git >= v2.14, it probably make sense to setup following globally:

git config --global core.symlinks true
git config --global submodule.recurse true

Notes:

to setup Symlinks & Submodules recurse locally only (for Ever repo), remove --global in the commands above
for older Git versions see this
at the moment we are not using Git sub-modules, but it may change in the future (we were using them, but decided to drop for now in favor of symlinks)

Yarn

Currently we are using Yarn (instead of npm), so make sure you have latest Yarn version installed before running Ever Platform:

npm install -g yarn@latest

Quick installation

After git repo is cloned, just run following command to install/bootstrap all dependencies:

yarn bootstrap

This will install required packages in all Platform projects using Lerna

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

Lerna (manual installation)

We are using Lerna for mono-repo management. You need to run the following command from working folder where you cloned Ever git repo, which will install Lerna together with other packages:

yarn

You may instead install Lerna globally:

npm install lerna@latest -g

Now, after Lerna installed (locally or globally), you need to Bootstrap all dependencies manually:

yarn lerna bootstrap

The command above will install all required packages for every sub-project of the Ever Platform.

MongoDB

You can download and install free Community version of MongoDB from the official MongoDB download center.

After installation, make sure MongoDB service is running and accepting connections on default localhost:27017 (change connection parameters in the ./backend/api/.env file if you run on different location/port)

To manage database, you can use free MongoDB Compass Community Edition available or some other GUI for MongoDB, e.g. Studio 3T (https://studio3t.com)

For production, we recommend MongoDB Atlas.
It is also possible to use AWS DocumentDB or Azure Cosmos DB

Note: we currently integrating Mongo Memory Server which will allow to test Platform without need to install MongoDB locally.

Platform Configuration

Default

We created templates & initial configuration files (with reasonable defaults) for each project in the Platform, to save your time and keep things simple.

In the Angular based projects, the "standard" environment configuration files environment.ts and environment.prod.ts will be auto-generated from .env file (if it's exists) or from default settings on the first app run.

So, the following files will be auto-generated:

in Admin UI: ./admin/website-angular/src/environments/environment.ts and ./admin/website-angular/src/environments/environment.prod.ts.
in Mobile Shop: ./shop/mobile-ionic/src/environments/environment.ts and ./shop/mobile-ionic/src/environments/environment.prod.ts
in Web Shop: ./shop/website-angular/src/environments/environment.ts and ./shop/website-angular/src/environments/environment.prod.ts
in Carrier App: ./carrier/mobile-ionic/src/environments/environment.ts and ./carrier/mobile-ionic/src/environments/environment.prod.ts
in Merchant App: ./merchant/tablet-ionic/src/environments/environment.ts and ./merchant/tablet-ionic/src/environments/environment.prod.ts

Note: you should never edit auto-generated files above and instead you should edit relevant .env files for custom configurations, see more details below.

Custom / Manual

For Backend (API) configuration, the ./backend/api/.env.template file should be copied into ./backend/api/.env and relevant changes should be done in the .env file. It means you should have ./backend/api/.env file in place to be able to run the Platform on developer machine if you want to use different settings to our defaults.
For Admin Angular App configuration, the ./admin/website-angular/.env.template file should be copied into ./admin/website-angular/.env and relevant changes should be done in the .env file.
For Merchant Ionic App configuration, the ./merchant/tablet-ionic/.env.template file should be copied into ./merchant/tablet-ionic/.env and relevant changes should be done in the .env file. If you need to run Merchant App using PM2 (as Web app, not Tablet App), needs copy ./merchant/tablet-ionic/.env.template to ./merchant/tablet-ionic/.env and make relevant changes (if required)
For Shopping Mobile App (Ionic) configuration, the ./shop/mobile-ionic/.env.template file should be copied into ./shop/mobile-ionic/.env and relevant changes should be done in the .env file.
For Shopping Website configuration, the ./shop/website-angular/.env.template file should be copied into ./shop/website-angular/.env and relevant changes should be done in the .env file.
For Carrier Mobile App (Ionic) configuration, the ./carrier/mobile-ionic/.env.template file should be copied into ./carrier/mobile-ionic/.env and relevant changes should be done in the .env file.

Notes:

For initial development no changes required in the .env files in the projects, unless some manual changes were done to the Backend (API) configuration. However, to enable some of the Platform features, you may need to change relevant configurations in corresponding .env files.
As a general rule, files .env are configurations you should never make public (and of course never commit to Git repo), unless you removed all private/secure parameters from them. In addition, for Angular based projects, you should never put any secure settings (e.g. Secret Keys, API Keys, etc) in environment.ts and environment.prod.ts files because all of them will be loaded into the browser and made public. Because we are using auto-generated environment.ts and environment.prod.ts files, it means you should never put any secure settings into .env files in our Angular projects. The only safe place to put your secure settings is .env file on the backend API/Server project!
We are using dotenv (.env) in Angular based projects for consistency with configuration between all our Platform projects only.

Run Platform Projects

Finally, each project from Ever Platform can be started by single command from this list:

 yarn run:server # Run API server
 yarn run:admin # Run Admin Website
 yarn run:merchant # Run Merchant Ionic Tablet App
 yarn run:shopmobile # Run Shopping Mobile App
 yarn run:shopweb # Run Shopping Website
 yarn run:carrier # Run Carrier Mobile app

Note: on the first run, API Server (Backend) will create MongoDB local database ever_development with the following (default) Admin user

email: admin@ever.co
password: admin

You can use credentials above to login into Platform Admin App, which available locally at http://localhost:4200 (by default)

Metrics

See below aproximate source code metrics for Ever Platform using cloc project.

github.com/AlDanial/cloc v 1.80  T=5.12 s (385.5 files/s, 27882.0 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
TypeScript                    1145          10151           4065          73840
HTML                           319           1005            135          15917
Sass                           298           1969            339          12800
JSON                            39             13              0           8258
CSS                             95           1196            665           5650
JavaScript                      50              8             87           3257
Markdown                         6            554              1           1426
GraphQL                         21            269             49           1091
XML                              1              0              0             11
-------------------------------------------------------------------------------
SUM:                          1974          15165           5341         122250
-------------------------------------------------------------------------------

Note: you can get latest metrics using yarn count from the root of mono-repo.

Contribute

Please give us ⭐ on Github, it really helps!
You are more than welcome to submit feature requests in the separate repo
Pull requests are always welcome! Please base pull requests against the develop branch and follow the contributing guide.

Collaborators and Contributors

Development Team

Core

Ruslan Konviser (Evereq)
Michael Konviser (Komish)

Developers

Alish Meklyov (Alish)
Blagovest Gerov (BlagovestGerov)
Boyan Stanchev (boyanstanchev)
Elvis Arabadjiyski (Dreemsuncho)
Emil Momchilov (jew-er)

Graphic Designer & QA

Julia Konviser

Contributors

View all of our contributors

Contact Us

Spectrum Community
Gitter Chat
Discord Chat
CodeMentor
Telegram
For business inquiries: mailto:ever@ever.co
Please report security vulnerabilities to mailto:security@ever.co
Ever Platform @ Twitter
Ever Platform @ Facebook

Security

Ever Platform follows good security practices, but 100% security cannot be guaranteed in any software!
Ever Platform is provided AS IS without any warranty. Use at your own risk!
See more details in the LICENSE.md.

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).

License

This software is available under different licenses

Ever Platform Community Edition License

Different parts of the Platform are made available under the terms of the separate Open-Source licenses:

Shopping Mobile App and Carrier Mobile App under GNU General Public License v3.0
Backend Api (Server), Admin Website, Merchant Tablet App and Merchant Website, Shopping Website under GNU Affero General Public License v3.0
Pyro shared modules under MIT License
Other shared modules under GNU General Public License v3.0

If you decide to choose the Ever® Platform Community™ Edition License, you must comply with the following terms:

This program is free software: you can redistribute it and/or modify it under the terms of the corresponding licenses described in the LICENSE.md files located in software sub-folders and under the terms of licenses described in individual files.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should have received a copy of the relevant GNU Licenses along with this program. If not, see http://www.gnu.org/licenses/.

Ever Platform Enterprise License

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.

For more information about Ever® Platform Enterprise™ License please contact mailto:ever@ever.co.

The default Ever® Platform™ license, without a valid Ever® Platform Enterprise™ License agreement, is the Ever® Platform Community™ Edition License.

Please see LICENSE.md for more information on licenses.

Trademarks

Ever® is a registered trademark of Ever Co. LTD.
Ever® Platform™, Ever® Platform Community™ and Ever® Platform Enterprise™ are all trademarks of Ever Co. LTD.

The trademarks may only be used with the written permission of Ever Co. LTD. and may not be used to promote or otherwise market competitive products or services.

All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.

muhassaf / ever