Platformer

Compose a SaaS platform through configuration.

Key Features

Build and deploy a platform through configuration rather than code
Ability to express all real world business logic for most businesses
Automatically generates all database migrations
Automatically generate documentation for your platform
Opinionated - GraphQL, oAuth2, Application and Database Level Data Validations
Performant and reliable, even at large scale
Includes Cloudformation Scripts to launch appropriate scalable infrastructure

Installation

Install the gem by executing:

$ gem install platformer

Create your new platform:

$ platformer create my_platform_name

Getting Started

Todo

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

We use Conventional Commit Messages.

Code should be linted and formatted according to Ruby Standard.

Publishing is automated via github actions and Googles Release Please github action

We prefer using squash-merges when merging pull requests because it helps keep a linear git history and allows more fine grained control of commit messages which get sent to release-please and ultimately show up in the changelog.

Type checking is enabled for this project. You can find the corresponding rbs files in the sig folder.

Install types for the packages used in development (such as rspec) by running

$ rbs collection install

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/craigulliott/platformer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

This software is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Platformer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.