nikolasmelui / gauzy

Gauzy™ - Fair Profits Sharing Platform for modern agencies and studios

Gauzy

Gauzy™ - Fair Profits Sharing Open-Source Platform

• Open-Source Software solving fair sharing of technology.
• Stock Options solving fair sharing of profits in the future.
• Gauzy solving fair sharing of profits today.

Read more About Gauzy and How to use it at your agency or studio.

Feel free to test:

• Gauzy Platform Demo at https://demo.gauzy.co (login with [email protected] and password: admin)
• Gauzy Platform SaaS at https://app.gauzy.co (WIP, planned)
• Gauzy Platform Dev builds (using CI/CD, from the develop branch) at https://app.gauzy.dev

Quick Start

With Docker Compose

• Clone repo
• Make sure you have Docker Compose installed locally
• Run docker-compose up
• ☕ time...
• Open http://localhost:8080 in your browser
• Login with email [email protected] and password: admin
• Enjoy

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

• Cross-platform client for PostgreSQL DBs pgweb, on http://localhost:8081
• Franchise, lightweight but powerful SQL tool with a notebook interface, on http://localhost:8082
• OmniDb, on http://localhost:8083 and using default credentials (admin:admin) configure connection string postgres://postgres:root@db:5432/postgres?sslmode=disable.
• Adminer Database management in a single PHP file, on http://localhost:8084

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
• 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

Note: during the first API start, DB will be automatically seed with initial data if no users found. You can run seed any moment manually (e.g. if you changed entities schemas) with yarn run seed command to re-initialize DB (warning: unsafe for production!).

Production

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

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

Technology Stack

• TypeScript
• Node.js
• Nx
• Angular 8
• Nest
• RxJS
• TypeORM
• Ngx-admin
• PostgreSQL

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

• Ruslan Konviser (Evereq)

Developers (alphabetical order)

• Aleksandar Tasev (AlexTasev)
• Alish Meklyov (Alish)
• Blagovest Gerov (BlagovestGerov)
• Boyan Stanchev (boyanstanchev)
• Elvis Arabadjiyski (Dreemsuncho)
• Emil Momchilov (jew-er)
• Hristo Hristov (hrimar)

Designers & QA

• Milena Dimova (UI/UX Designer)
• Julia Konviser (Graphic Designer, QA)

Contributors

• View all of our contributors

Contact Us

• Slack Community
• Spectrum Community
• Gitter Chat
• CodeMentor
• For business inquiries: mailto:[email protected]
• Please report security vulnerabilities to mailto:[email protected]
• Gauzy Platform @ Twitter
• Gauzy Platform @ Facebook

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

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, Ever Co. LTD. All rights reserved.