@goatlab/fluentjs

GOAT-FLUENT

Readable query Interface & API generator
Explore the docs »

View Demo · Report Bug · Request Feature

Goat - Fluent

Fluent query interface for Multiple database types and helpers for fast API generation and general App building.

Supported Databases

1. Firebase**
2. MongoDB*
3. Mysql*
4. MariaDB*
5. SQLite*
6. Postgres*
7. CockroachDB*
8. Microsoft SQL Server*
9. Oracle*
10. SAP Hana*
11. sql.js*
12. LokiJS
13. In-memory

Wrapper for TypeORM *

Wrapper for firebase-admin and fireorm **

Installing

To install this package in your project, you can use the following command within your terminal.

npm install --global @goatlab/fluent

Documentation

To learn how to use this visit the Goat Docs

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

We use a few tools to help with code styling, pre-commits, versioning, changelog and releases.

• Pretty-quick
• Husky
• Auto-changelog
• Release-it

All of these should run out of the box with your dev dependencies

1. If you have an issue assigned, please include the issue code/id in the beginning of you commits.
2. Include the issue id also at the start of your PR message.
3. Fork the Project
4. Create your Feature Branch (git checkout -b feature/AmazingFeature)
5. Commit your Changes (git commit -m 'Add some AmazingFeature')
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

Release Process

1. All PRs will be merge directly into Master. (If test are green)
2. Once we are ready to create a release, we will locally pull the latest master version and run the release process

If patch release

npm run release

If minor release

npm run release:minor

If mayor release

npm run release:mayor

This will start the release scripts including:

• Local tests
• Final version building
• Final release zip
• Tag
• Release
• Push

Continuous Deployment

Continuous deployment is optional. We will trigger a deployment with every published release. The equivalent trigger in Github Actions is:

on:
  release:
    types: [published]

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ignacio Cabrera - @twitter_handle - [e-mail]

Acknowledgements

• Tomas Castro