Skip to content

Latest commit

 

History

History
281 lines (179 loc) · 15 KB

README.md

File metadata and controls

281 lines (179 loc) · 15 KB
Raw

Ever Teams Platform

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

⭐️ What is it?

Ever® Teams™ - Open Work and Project Management Platform.

web

NOTE: Platform currently is in active development stage / WIP, please use with caution!

✨ Features

Below is a list of the most important planned features:

  • Work / Workforce Management
  • Time Management / Time Tracking / Activity Tracking
  • Productivity Tracking & Metrics
  • Projects / Tasks & Issues Management
  • Organizations / Teams
  • Tags / Labels
  • Integrations (GitHub, GitLab, Bitbucket, JIRA, etc.)
  • Dark / Black / Light Themes

🌼 Screenshots

Show / Hide Screenshots

Web Platform

web web web

Mobile Apps (iOS/Android)

mobile

Browser Extension

extension

Note: Currently WIP, the screenshot is just a temporary picture :)

📊 Activity

Alt

🔗 Links

⚡️ Our Open Platforms

Ever® Teams™ Platform (https://app.ever.team) is built on top of our Business Management Platform (ERP/CRM/HRM) - Ever® Gauzy™ Platform (https://gauzy.co), which itself is a part of our larger Open Platform for On-Demand and Sharing Economies - Ever®. You can get more information about all our products at https://ever.co.

🧱 Technology Stack and Requirements

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 official Platform Documentation (WIP) and to our Wiki (WIP).

🚀 Getting Starting

Super Quick Start

https://app.ever.team

Quick Start with our public live APIs

  1. Clone this repo
  2. Run yarn install
  3. Run yarn build:web && yarn start:web OR yarn start:web:dev
  4. Open in http://localhost:3030 in your Browser

Notes:

  • by default, Ever Teams web frontend will be connected to our production Ever Gauzy API API endpoint https://api.ever.team. You can change it in environment variables GAUZY_API_SERVER_URL and NEXT_PUBLIC_GAUZY_API_SERVER_URL, see below how to run with a Self-hosted Backend.

Run with a Self-hosted Backend

  1. Download and run the Ever Gauzy Server setup (https://gauzy.co/downloads) or run the server manually (see https://github.com/ever-co/ever-gauzy/tree/develop/apps/server). You can also run only Ever Gauzy APIs (manually), see https://github.com/ever-co/ever-gauzy/tree/develop/apps/api. For getting starting instructions, it's best to check the Ever Gauzy README file.
  2. Clone this repo
  3. After you get the API or Server running, make sure you set the environment variables GAUZY_API_SERVER_URL and NEXT_PUBLIC_GAUZY_API_SERVER_URL in Ever Teams .env file (see https://github.com/ever-co/ever-teams/blob/develop/web/.env.sample). For example, you can set those env vars to http://localhost:3000 if Gauzy APIs run on that host & port.
  4. Run yarn install
  5. Run yarn build:web && yarn start:web OR yarn start:web:dev
  6. Open in http://localhost:3030 in your Browser

Notes

Note: Ever® Teams™ requires access to Ever® Gauzy™ Platform APIs, provided by another project - Ever® Gauzy™ Platform, see https://github.com/ever-co/ever-gauzy (and also https://gauzy.co). Specifically, you might be interested in the apps/api and apps/server folders of the mono-repo for the Gauzy API & Gauzy Server code.

Run in Gitpod

  • Launch a ready-to-use Gitpod workspace (WIP):

Open in Gitpod

Run in DevContainer

DevContainers for VSCode are supported (WIP).

Click here to get started.

Run in Docker & Docker Compose

WIP

🚗 Self Hosting

DigitalOcean

Please see our Wiki.

Vercel

Deploy with Vercel

Render

Deploy to Render

Railway

Deploy to Railway

Fly

Deploy to Fly

Netlify

Deploy to Netlify

Heroku

Deploy to Heroku

Koyeb

Deploy to Koyeb

Northflank

Deploy to Northflank

📄 Content

  • /apps/web - NextJs-based (React) Web App at https://app.ever.team (deployed from main branch)
  • /apps/mobile - Expo (ReactNative) powered mobile app
  • /apps/desktop - Electron-based Desktop Application (customized build from Ever Gauzy Desktop Timer App)
  • /apps/extensions - Browser Extensions (powered by https://github.com/PlasmoHQ/plasmo)
  • /apps/server-api - Ever Teams API Server (customized build from Ever Gauzy API Server)
  • /apps/server-web - Electron-based Ever Teams Web Server that serves Ever Teams NextJs frontend (wraps apps/web folder)

💌 Contact Us

🔐 Security

Ever Teams Platform follows good security practices, but 100% security cannot be guaranteed in any software! Ever Teams Platform is provided AS IS without any warranty. Use at your own risk! See more details in the LICENSES.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 emailing mailto:[email protected] and not by creating a GitHub issue.

🛡️ License

This software is available under the following licenses:

The default Ever® Teams™ Platform license, without a valid Ever® Teams™ Platform Enterprise or Ever® Teams™ Platform Small Business License agreement, is the Ever® Teams™ Platform Community Edition 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 to acceptance criteria) Ever Teams Enterprise edition license and free hosting option! Feel free to contact us at mailto:[email protected] to make a request. More details are explained in our Wiki.

Please see LICENSES for more information on licenses

FOSSA Status

™️ Trademarks

Ever® is a registered trademark of Ever Co. LTD. Ever® Demand™, Ever® Gauzy™, Ever® Teams™ 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.

🍺 Contribute

  • Please give us a ⭐ on Github, it 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.

💪 Thanks to our Contributors

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

⭐ Star History

Star History Chart

❤️ Powered By

Powered by Vercel

©️ Copyright

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

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

🔥 P.S