We released Ever Teams - an Open Work and Project Management Platform.
Please check https://github.com/ever-co/ever-teams and make it ā on GitHub!
It's built with a React and React Native stack and connects to headless Ever Gauzy Platform APIs.
EverĀ® Demandā¢ - Open Platform for Collaborative, On-Demand and Sharing Economies.
It's an Open-Source, Real-Time, and Reactive Platform built with TypeScript.
You are welcome to check more information about the platform at our official website - https://ever.co.
Demos are not available at the moment as we are moving to Kubernetes and showdown old demo server!
You can also track feature requests from the community in the separate repo.
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 :bug: and please be nice! :stuck_out_tongue_winking_eye:
Please refer to our official Platform Documentation and to our Wiki (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.md for Server (Backend) related overview.
We follow Gitflow Workflow, so the develop
branch may be in an unstable or even broken state during development. Please use releases or master
branch instead of the develop
branch in order to get more stable code.
Clone the Ever Platform Git repo:
git clone https://github.com/ever-co/ever-demand.git
IMPORTANT NOTE:
--branch develop
(our default branch).--branch master
.Currently, we are using Yarn
(instead of npm
), so make sure you have the latest Yarn version installed before running Ever Platform:
npm install -g yarn@latest
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 running yarn
inside every sub-folder of the packages
folder with the 'package.json' file
You can build all projects in Ever Platform using the single command below:
yarn build:all
Note: The parallel build is available using yarn build
command
We are using Lerna for 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 running yarn
inside 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.
Ever Demand 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.
See the relevant section in our documentation.
After you build everything (yarn build:all
, described above), each project from Ever Platform could be started by single command from this list:
yarn run:server
yarn run:admin
and open http://localhost:4200yarn run:shopmobile
and open http://localhost:4201yarn run:merchant
and open http://localhost:4202yarn run:carrier
and open http://localhost:4203yarn run:shopweb
and open http://localhost:3000Note 1: It is important to build shared / common platform modules (yarn build:common
or yarn build:all
) before running the Platform Core (API) or Apps
Note 2: During development, you can run a server with yarn run:server:dev
to enable watch on TS file changes
Note 3: On the first run, the API Server (Backend) creates MongoDB local database ever_development
with the following (default) Admin user
admin@ever.co
admin
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.
According to 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.
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 the LICENSE.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 to mailto:security@ever.co or on and not by creating a GitHub issue.
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 to acceptance criteria) Ever Demand Enterprise edition license and free hosting option! Feel free to contact us at mailto:ever@ever.co to make a request. More details are explained in our Wiki.
This software is available under the following licenses:
EverĀ® is a registered trademark of Ever Co. LTD. EverĀ® Demandā¢, EverĀ® Gauzyā¢ and EverĀ® OpenSaaSā¢ 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.
See our contributors list in CONTRIBUTORS.md.
You can also view a full list of our contributors tracked by Github.