https://github.com/jlblcc/mdjsonapi

mdEditor compatible Rails JSONAPI example
https://github.com/jlblcc/mdjsonapi

Last synced: about 1 month ago
JSON representation

mdEditor compatible Rails JSONAPI example

• Host: GitHub
• URL: https://github.com/jlblcc/mdjsonapi
• Owner: jlblcc
• License: lgpl-3.0
• Created: 2020-03-05T20:09:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T17:45:51.000Z (almost 2 years ago)
• Last Synced: 2024-10-18T19:51:15.067Z (3 months ago)
• Language: Ruby
• Size: 64.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdJSON API: A demo of a mdEditor compatible JSONAPI server

This is a very basic implementation of an Rails API that follows the JSON API spec and is usable as a mdEditor datastore. mdJSON API is based on  and uses [JSONAPI-Resources](https://jsonapi-resources.com/) and Postgresql.

Currently, support is only setup for storing Contacts. However, adding basic support for Metadata and Dictionaries would be trivial. See .

## Running this app

This app requires that postgresql be installed locally. General instructions are available

[here](https://wiki.postgresql.org/wiki/Detailed_installation_guides) for many operating systems.

After cloning this repo, run the following:

```bash

bundle

```

Ensure that your `config/database.yml` is configured properly, and then run:

```bash

rake db:create db:migrate

```

Start your server:

```bash

rails server

```