An open API service indexing awesome lists of open source software.

https://github.com/clivern/muffin

🐺 Multi-Language Coding Playground Platform.
https://github.com/clivern/muffin

clivern coding-platform muffin playground ruby ruby-on-rails

Last synced: 2 months ago
JSON representation

🐺 Multi-Language Coding Playground Platform.

Awesome Lists containing this project

README

        



Muffin


Multi-Language Coding Playground Platform.













## Documentation

### Getting Started

In order to run `muffin`, you need `ruby` `>=` `2.7.4` and `nodejs`. Then run the following commands:

```zsh
$ gem install bundler

$ make setup
```

To run the application:

```zsh
$ cp .env .env.local
# Then adjust .env.local
$ source .env.local
$ export $(cut -d= -f1 .env.local)

$ make run
```

To run test cases:

```zsh
$ make ci
```

To list all commands:

```zsh
$ make
```

## Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Muffin is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.

See the [Releases section of our GitHub project](https://github.com/clivern/muffin/releases) for changelogs for each release version of Muffin. It contains summaries of the most noteworthy changes made in each release.

## Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/muffin/issues

## Security Issues

If you discover a security vulnerability within Muffin, please send an email to [[email protected]](mailto:[email protected])

## Contributing

We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.

## License

© 2021, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).

**Muffin** is authored and maintained by [@clivern](http://github.com/clivern).