https://github.com/vladfaust/onyx-todo-json-api

Creating JSON APIs with Onyx
https://github.com/vladfaust/onyx-todo-json-api

onyxframework

Last synced: about 1 year ago
JSON representation

Creating JSON APIs with Onyx

• Host: GitHub
• URL: https://github.com/vladfaust/onyx-todo-json-api
• Owner: vladfaust
• License: mit
• Created: 2019-03-10T17:48:30.000Z (over 7 years ago)
• Default Branch: part-1
• Last Pushed: 2019-08-13T11:37:21.000Z (almost 7 years ago)
• Last Synced: 2025-02-05T21:39:03.031Z (over 1 year ago)
• Topics: onyxframework
• Language: JavaScript
• Homepage: https://blog.onyxframework.org/posts/creating-json-apis-with-onyx-part-1/
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Built with Crystal](https://img.shields.io/badge/built%20with-crystal-000000.svg?style=flat-square)](https://crystal-lang.org/)

[![Travis CI build](https://img.shields.io/travis/vladfaust/onyx-todo-json-api/part-1.svg?style=flat-square)](https://travis-ci.org/vladfaust/onyx-todo-json-api)

This repository contains code from the [Creating JSON APIs with Onyx](https://blog.onyxframework.org/posts/creating-json-apis-with-onyx-part-1/) tutorial series blog posts. It is powered by [Crystal](https://crystal-lang.org/) and [Onyx Framework](https://onyxframework.org/). The code is split to branches in accordance to the tutorial parts:

1. [Part 1 — The First Endpoint](https://blog.onyxframework.org/posts/creating-json-apis-with-onyx-part-1/) ⎇ part-1 (current)

2. [Part 2 — CRUD](https://blog.onyxframework.org/posts/creating-json-apis-with-onyx-part-2/) ⎇ [part-2](https://github.com/vladfaust/onyx-todo-json-api/tree/part-2)

## Installation

0. Install Crystal. See the [installation instructions](https://crystal-lang.org/reference/installation/index.html).

1. Clone the repository:

```sh

> git clone https://github.com/vladfaust/onyx-todo-json-api && cd onyx-todo-json-api

```

2. Install dependenies:

```sh

> shards install

```

3. Run the server:

```sh

> crystal src/server.cr

```

## Contributors

- [Vlad Faust](https://github.com/your-github-user) - creator and maintainer

## Licensing

This software is licensed under [MIT License](LICENSE).

[![Open Source Initiative](https://upload.wikimedia.org/wikipedia/commons/thumb/4/42/Opensource.svg/100px-Opensource.svg.png)](https://opensource.org/licenses/MIT)