Skip to content

ever-co/ever-demand

Repository files navigation

Open Commerce Platform

Gitpod Ready-to-Code Join the community on Spectrum Gitter Get help on Codementor

💡 What's New

We releasedEver Teams- an Open Work and Project Management Platform.
Please checkhttps://github /ever-co/ever-teamsand make it ⭐ on GitHub!
It's built with a React and React Native stack and connects to headlessEver Gauzy PlatformAPIs.

🌟 What is it

Ever® Demand™- Open Platform forCollaborative,On-DemandandSharingEconomies.

It's an Open-Source, Real-Time, and Reactive Platform built withTypeScript.
You are welcome to check more information about the platform at our official website -https://ever.co.

overview

💻 Demos

Demos are not available at the moment as we are moving to Kubernetes and showdown old demo server!

Video Intros

  • Introduction of both Ever Demand and Ever Gauzy platforms -view video(~30 min) ordownload
  • Introduction to Ever Demand Mobile Shop customer experience (UX) -view video(~30 min) ordownload

✨ Features

Current Features

  • Supports Single-Store and Multi-Store / Multi-Vendor / Peer-to-Peer / Digital Marketplaces
  • Everything Reactive, Real-Time, and Blazing Fast!
  • Headless Commerce framework, which allows different implementations of store-fronts, Admin UIs, and client apps. It exposes rich GraphQL, REST, and WS APIs.
  • Mobile ordering App for customers to make On-Demand orders (Hybrid / PWA, iOS and Android using Ionic / Ionic Native)
  • Carrier (Driver) Mobile App for deliveries by carriers, drivers, or service providers (iOS and Android using Ionic / Ionic Native)
  • Customizing Shopping e-commerce Website for customers to make in-browser On-Demand purchases of food, goods or services
  • Merchant Tablet App for 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 across Platform (i18N)
  • Product catalogs (global and per Merchant) with Multiple Product Images
  • Inventory/Stock Management and Real-time Order Management/Processing across the Platform
  • Deliveries/Shipping management and processing across the Platform (shipping with real-time location tracking for On-Demand orders)
  • Real-time discounts, promotions, and product/service availability updates
  • Customer 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 provider integrations
  • User Roles / Permissions across Platform
  • Large product catalogs with product variants, facets, and full-text search

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

Disclaimer

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

🧱 Technology Stack and Requirements

  • Full-stackTypeScript- frontends andNodeJs/Nestbackend.
  • Headless Commerce framework (Backend APIs/Server) developed usingNest.Supports GraphQL, REST and WS Real-Time APIs (WebSockets usingSocket.iolibrary).
  • Ionic(version 5) for Carrier Mobile App and Merchant Tablet App.
  • Shopping Mobile App built withIonic(version 5).
  • Shopping Mobile App built withReact NativeusingExpo(WIP).
  • Shopping Mobile App built withFlutter/ Dart (WIP).
  • Shopping Website developed withAngular(version 9.1) usingAngular Starter.
  • Admin Website developed withAngular(version 9.1) usingngx-admin.
  • RxJSlibrary used heavily in every part of the Platform.
  • InversifyJSused for Inversion Control / Dependency Injection in most parts of the Platform. On the Backend/API we also use DI provided byNest.
  • MongoDBDatabase used withMongooseORM (supported MongoDB version >= 3.2; we recommend version >=4).
  • We have an ongoing effort (WIP) to add support for other databases usingTypeORMandPrisma.The following additional DBs will be fully supported: MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, and Oracle.
  • For production, we integrate and recommend usingPM2.

See also README.md and CREDITS.md files in relevant folders for lists of libraries and software included in the Platform, information about licenses and other details.

📄 Documentation

Please refer to our officialPlatform Documentationand to ourWiki(WIP).

For a quick overview of each project in the Platform (Server, Admin, Shops, etc.), you can search for the README.md file in the root of the project's folders. For example, see./backend/api/README.mdfor Server (Backend) related overview.

📊 Activity

Alt

🚀 Getting Started

We followGitflow Workflow,so thedevelopbranchmay be in an unstable or even broken state during development. Please usereleasesormasterbranchinstead of thedevelopbranch in order to get more stable code.

Clone Repo

Clone the Ever Platform Git repo:

git clone https://github /ever-co/ever-demand.git

IMPORTANT NOTE:

  • If you want to use a develop branch (unstable, but latest development) clone using--branch develop(our default branch).
  • If you want to use a release branch (more stable) clone use--branch master.

Yarn

Currently, we are usingYarn(instead ofnpm), so make sure you have the latest Yarn version installed before running Ever Platform:

npm install -g yarn@latest

Quick installation

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

yarn bootstrap

The above command installs the required packages in all Platform projects using Lerna.

Note: if the above command fails for any reason, you can try to install the required packages manually by runningyarninside every sub-folder of thepackagesfolder with the 'package.json' file

Build

You can build all projects in Ever Platform using the single command below:

yarn build:all

Note: The parallel build is available usingyarn buildcommand

Lerna (manual installation)

We are usingLernafor mono-repo management. You need to run the following command from the working folder where you cloned the Ever Demand Git repo, which installs Lerna together with other packages:

yarn

You may instead install Lerna globally:

npm install lerna@latest -g

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

yarn lerna bootstrap

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

Note: if the above command fails for any reason, you can try to install the required packages manually by runningyarninside every sub-folder with 'package.json' file.

After Lerna bootstraps everything you need to run the build for all projects as described above in the "Build" section.

MongoDB

Ever Demand platform configured to use MongoDB by default and assume you have MongoDB service running and accepting connections on the defaultlocalhost:27017.Please see relevant section in ourdocumentation.

Platform Configuration

See the relevant section in ourdocumentation.

Run Platform Projects

After you build everything (yarn build:all,described above), each project from Ever Platform could be started by single command from this list:

Note 1: It is important to build shared / common platform modules (yarn build:commonoryarn build:all) before running the Platform Core (API) or Apps

Note 2: During development, you can run a server withyarn run:server:devto enable watch on TS file changes

Note 3: On the first run, the API Server (Backend) creates MongoDB local databaseever_developmentwith the following (default) Admin user

You can use the credentials above to login into Platform Admin App.

Note 3: In order to be able to run every project, you need to make sure everything builds, see section "Build" above.

Metrics

According toclocproject, 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 ourdocumentation.

💌 Contact Us

🔐 Security

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

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

If you discover any issue regarding security, please disclose the information responsibly by sending an email tomailto:[email protected]or onhuntrand not by creating a GitHub issue.

🛡️ License

We support the open-source community. If you're building awesome non-profit/open-source projects, we're happy to help and will provide (subject toacceptance criteria) Ever Demand Enterprise edition license and free hosting option! Feel free to contact us atmailto:[email protected]to make a request. More details are explained in ourWiki.

This software is available under the following licenses:

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

Please seeLICENSE.mdfor more information on licenses. You can alsocompare our offering.

FOSSA Status

Trademarks

Ever® is a registered trademark ofEver Co. LTD. Ever® Demand™,Ever® Gauzy™andEver® OpenSaaS™are all trademarks ofEver 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.

🍺 Contribute

  • Please give us ⭐ on Github, ithelps!
  • You are more than welcome to submit feature requests in theseparate repo
  • Pull requests are always welcome! Please base pull requests against thedevelopbranch and follow thecontributing guide.

💪 Thanks to our Contributors

See our contributors list inCONTRIBUTORS.md.
You can also view a full list of ourcontributors tracked by Github.

⭐ Star History

Star History Chart

❤️ Powered By

©️ Copyright

Copyright © 2016-present, Ever Co. LTD. All rights reserved.


visitors huntr Circle CI codecov Codacy Badge DeepScan grade Known Vulnerabilities Total alerts Language grade: JavaScript FOSSA Status lerna Crowdin

🔥 P.S.