https://github.com/martenframework/website

The Marten framework website.
https://github.com/martenframework/website

crystal crystal-lang framework marten web website

Last synced: 19 days ago
JSON representation

The Marten framework website.

• Host: GitHub
• URL: https://github.com/martenframework/website
• Owner: martenframework
• License: mit
• Created: 2021-11-16T03:33:11.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-24T21:11:22.000Z (about 1 month ago)
• Last Synced: 2024-11-24T22:19:23.791Z (about 1 month ago)
• Topics: crystal, crystal-lang, framework, marten, web, website
• Language: Crystal
• Homepage: https://martenframework.com
• Size: 2.22 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: news/2022/2022-10-25-marten-bugfix-release-0.1.1.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Marten Framework Website

[![CI](https://github.com/martenframework/website/workflows/Specs/badge.svg)](https://github.com/martenframework/website/actions) [![CI](https://github.com/martenframework/website/workflows/QA/badge.svg)](https://github.com/martenframework/website/actions)

This repository contains the Marten Framework website project.

## System requirements

* [Crystal](https://crystal-lang.org/) 1.14+

* [Node.js](https://nodejs.org/en/) - 18.x

## Installation

If all the above system dependencies are properly installed on the target system, it should be possible to install the project using the following command:

```shell

$ make

```

This command will take care of the installation of the required the dependencies and will build the development assets.

## Running the development server

The development server can be started using the following command:

```shell

$ make server

```

The development server should be accessible at http://127.0.0.1:8000.

## Running the test suite

The test suite can be run using the following command:

```shell

$ make tests

```

Code quality checks can be triggered using the following command:

```shell

$ make qa

```

## License

MIT. See `LICENSE` for more details.