Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/codingitwrong/slapdash

An application for creating public Markdown-based notes.
https://github.com/codingitwrong/slapdash

Last synced: 2 days ago
JSON representation

An application for creating public Markdown-based notes.

Awesome Lists containing this project

README

        

# Slapdash

An application for creating public Markdown-based notes.

Notes are available at the path `/username/notename`. Markdown is parsed with [kramdown](https://github.com/gettalong/kramdown). Code blocks are syntax-highlighted with [Prism](https://prismjs.com/).

## Getting Started

### Requirements

1. Ruby
1. PostgreSQL (e.g. [Postgres.app][postgres-app])
1. Yarn

### Testing

```sh
$ bin/rspec
```

### Running

```sh
$ bin/dev
```

(Necessary to run Sass bundler)

[postgres-app]: http://postgresapp.com