Logo

Vizbor

Vizbor is a high-level Crystal web framework that encourages rapid development and clean, pragmatic design. It’s free and open source.

Build Status Docs Crysta GitHub release GitHub license GitHub repository

TODO: Write a description here


Status Project

Vizbor is based on the lightning fast, super simple Kemal web framework.
For more information see Kemal.

Requirements

View the list of requirements.

Installation

  1. Install MongoDB (if not installed):
    Fedora Debian Ubuntu Linux Mint

  2. Install additional libraries (if not installed):
    Fedora Debian Ubuntu Linux Mint

  3. Add the dependency to your shard.yml:

    dependencies:
      vizbor:
        github: kebasyaty/vizbor
    
    development_dependencies:
      ameba:
        github: crystal-ameba/ameba
      spec-kemal:
        github: kemalcr/spec-kemal
      vcli:
        github: kebasyaty/vcli
  4. Install dependencies and initialize the project:

    shards install
    bin/vcli --init AppName
    # or
    shards install && cp bin/vcli ~/.local/bin/vizbor
    vizbor --init AppName

Usage

TODO Write usage instructions here

Contributing

  1. Fork it (https://github.com/kebasyaty/vizbor/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

Changelog

View the change history.

License

This project is licensed under the MIT.



Made with Crystal