Skip to content

Latest commit

 

History

History
213 lines (155 loc) · 11.4 KB

README.md

File metadata and controls

213 lines (155 loc) · 11.4 KB
Raw

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.

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

Feel free to test a Demo http://demo.gauzy.co:4250 on our server. Login: [email protected] and password: admin.

In the future we will have the following:

Quick Start

With Docker Compose

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 [email protected] 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 will make Clouds deployments possible with a single command (pulumi up)

Note: it's WIP, currently supports AWS EKS (Kubernetes) and Fargate Clusters (for web app and backend api), Application Load Balancers and AWS RDS Serverless PostgreSQL DB deployments.

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 GNU Affero General Public License v3.0

This program is free software: you can redistribute it and/or modify it under the terms of the corresponding licenses described in the LICENSE 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/.

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.

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

visitors Circle CI codecov Codacy Badge DeepScan grade Known Vulnerabilities Greenkeeper badge FOSSA Status

P.S.