1 | # Carte
|
2 |
|
3 | * client: [![npm version](https://badge.fury.io/js/carte-client.svg)](http://badge.fury.io/js/carte-client) [![npm dependencies](https://david-dm.org/tily/carte.svg)](https://david-dm.org/tily/carte)
|
4 | * server: [![gem version](https://badge.fury.io/rb/carte-server.svg)](http://badge.fury.io/rb/carte-server) [![Code Climate](https://codeclimate.com/github/tily/carte/badges/gpa.svg)](https://codeclimate.com/github/tily/carte) [![Build Status](https://travis-ci.org/tily/carte.svg?branch=master)](https://travis-ci.org/tily/carte)
|
5 |
|
6 | Something like dictionary, wiki, or information card.
|
7 |
|
8 | ## Screenshot
|
9 |
|
10 | ![](screenshot.png)
|
11 |
|
12 | You can try carte on [sandbox](http://carte-sandbox.herokuapp.com/#/). There is also [a French-Japanese dictionary version](https://carte-francais.herokuapp.com/#/).
|
13 |
|
14 | ## Features
|
15 |
|
16 | * Manage your data fragments with cards
|
17 | * Create, edit and search cards quickly
|
18 | * View your card with the cards around it (like paper dictionary)
|
19 | * No user concept, super simple system like wiki
|
20 |
|
21 | Japanese introduction is [here](http://tily.tumblr.com/post/117678137942/carte).
|
22 |
|
23 | ## Components
|
24 |
|
25 | | Package Name | Description |
|
26 | |--------------|-------------|
|
27 | | [carte-server](https://rubygems.org/gems/carte-server) | provides JSON API (document is [here](https://github.com/tily/carte/wiki/API)) |
|
28 | | [carte-client](https://www.npmjs.com/package/carte-client) | builds client side javascript |
|
29 |
|
30 | ## Deploy
|
31 |
|
32 | **Heroku**
|
33 |
|
34 | [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/tily/carte-sandbox)
|
35 |
|
36 | **Docker**
|
37 |
|
38 | ```bash
|
39 | $ docker build -t carte .
|
40 | $ docker run --name mongo -d mongo
|
41 | $ docker run --name carte --link mongo:mongo -p 80:80 -d carte
|
42 | ```
|
43 |
|
44 | After deployment, you may want to [customize your carte](https://github.com/tily/carte/wiki/Configuration).
|