Skip to content
develop
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Aug 15, 2020

README.md

Gauzy Platform

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

Gauzy™ Platform - Open-Source Business Management Platform focused on Fairness and Transparency for freelancers, modern agencies, studios and in-house teams.

You are welcome to check more information about the platform at our official website - https://ever.co/features-gauzy-platform.

Gauzy Platform includes multiple ERP/CRM features, usually available in the accounting, human resources, invoicing, time management and project management software:

  • Dashboard (provides overview of different metrics, such as company income / expenses, employees bonuses, etc.)
  • Contacts Management (Clients / Customers / Leads / etc.)
  • Employees Management (register of company employees / contractors, rates of employees, etc.)
  • Employees Onboarding / Candidates Interviews
  • Time Management / Time Tracking / Activity Tracking / Timesheets
  • Schedules / Appointments / Events
  • Project Management / Tasks
  • Goals / KPI / Objectives / Key Results
  • Sales Pipelines
  • Proposals
  • Accounting / Invoicing / Estimates
  • Billing
  • Payments
  • Income / Expenses Management
  • Time Off Management / Holidays / Approvals
  • Inventory
  • Equipment / Sharing
  • Organization Departments and Teams
  • Organization Clients and Vendors
  • Help Center / Knowledge Base
  • Multiple Organizations Management
  • Tags / Labels
  • Reports
  • Organization and Employee Public Pages
  • Integrations (Upwork, HubStaff, etc.)
  • Email History / Email Templates
  • Data Import / Export
  • Roles / Permissions
  • Multi-currency
  • Multi-language
  • Dark / Light / Corporate and other Themes

So, while initially the primary purpose of Gauzy Platform was to allow transparent and fair accounting, profits sharing and bonuses calculation, today you can also use Gauzy software as the modern and intelligent platform to run your Outsourcing/Freelance Agency or Studio business in a completely new, open way.

In addition, we encourage individual Freelancers to join our "Gauzy" revolution and use the platform to jump start your open business!

Read more About Gauzy and How to use it at your freelance business, agency, studio or in-house teams.

Demos, Testing and Production

Desktop App

  • Download Gauzy Desktop App for your OS. Currently you can get latest release on https://github.com/ever-co/gauzy/releases/tag/v0.1.0.
  • Setup Gauzy Desktop App and run it
  • Select "Local", "Sqlite" and "Default" (that set port 3000 value for API). Click "Save" and after a couple of seconds (minutes) it will create local Sqlite DB for testing of Gauzy.
  • Gauzy Desktop App is ready to use.
  • You can login with admin@ever.co and password admin to check Admin functionality. Note: such Admin user is not an employee, so you will not be able to track time.
  • You can login with ruslan@ever.co and password admin to check Desktop Timer and other functionality from "Employee" perspective (such user is an Employee).

Note: Desktop App can connect to ActivityWatch* API to collect more statistics related to running apps and visited Urls. If you need that functionality, you can install ActivityWatch* and make sure it's running and you selected "ActivityWatch" checkbox in Gauzy Desktop App.

Quick Start

With Docker Compose

  • Clone repo
  • Make sure you have Docker Compose installed locally
  • Run docker-compose up, if you want to build everything (code and Docker images) locally
  • Run docker-compose -f docker-compose.demo.yml up, if you want to run the platform using our prebuild Docker images (note: images might be outdated)
  • time...
  • Open http://localhost:8080 in your browser
  • Login with email admin@ever.co and password: admin
  • Enjoy

Note: together with Gauzy, Docker Compose will run following:

Manually

  • Install and run latest PostgreSQL (optionally, other DB can be configured manually).
  • Install Yarn (if you don't have it) with npm i -g yarn
  • Install NPM packages with yarn install
  • Optionally, if you want to seed a lot of fake data for demo testing, run yarn seed:all
  • Run API with yarn start:api (by default runs on http://localhost:3000/api)
  • Run Gauzy front-end with yarn start
  • Open http://localhost:4200 in your browser
  • Login with email admin@ever.co and password: admin
  • Enjoy

Notes:

  • during the first API start, DB will be automatically seed with minimum set of initial data if no users found.
  • you can run seed any moment manually (e.g. if you changed entities schemas) with yarn seed command to re-initialize DB (warning: unsafe for production!).
  • it is possible to run generation of extremely large amount of fake data for demo purposes / testing with yarn seed:all (warning: takes ~10 min to complete)

Production

  • Check Gauzy Pulumi project, it makes Clouds deployments possible with a single command (pulumi up)

Note: it currently supports AWS EKS (Kubernetes) for development and production (recommended) with Application Load Balancers and AWS RDS Serverless PostgreSQL DB deployments. In addition, we implemented deployments to ECS EC2 and Fargate Clusters.

Technology Stack

Note: thanks to TypeORM, Gauzy will support lots of DBs: MySql, MariaDb, PostgreSQL, CockroachDb, sqlite, MS SQL, Oracle, MongoDb and others, with minimal changes.

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.

How to use Nx

Please see our Wiki page about Nx usage

Contribute

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

Collaborators and Contributors

Development Team

Core

Developers (alphabetical order)

Designers & QA

Contributors

View full list of our contributors.

Contact Us

Security

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

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

License

This software is available under following licenses:

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

Please see LICENSE.md for more information on licenses. You can also compare our offering.

FOSSA Status

Trademarks

Gauzy™ is a trademark of Ever Co. LTD.
All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.

Legal Notice

The links to third-party software are being provided as a convenience and for informational purposes only; they do not constitute an endorsement or an approval of any of the products, services or opinions of the corporation or organization or individual. Ever Co. LTD bears no responsibility for the accuracy, legality or content of the external sites or applications or for that of subsequent links. Contact the external site or application vendor for answers to questions regarding its content.

Please see the list of third-party software below:

Copyright

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

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

P.S.

You can’t perform that action at this time.