Skip to content

Commit 6267e09

Browse files
author
Lee Richmond
committed
Add readme
1 parent de54d14 commit 6267e09

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
1-
# README
1+
# jsonapi_suite sample app
22

3-
This README would normally document whatever steps are necessary to get the
4-
application up and running.
3+
This is a sample application for [jsonapi_suite](https://jsonapi-suite.github.io/jsonapi_suite). You can use this reference implementation to help track down errors if you end up having trouble.
54

6-
Things you may want to cover:
5+
Be sure to check out `spec/api` as well!
76

8-
* Ruby version
7+
### Running
98

10-
* System dependencies
9+
To run the rails backend:
1110

12-
* Configuration
11+
* `bundle install`
12+
* `bin/rake db:migrate`
13+
* `bin/rake db:seed`
1314

14-
* Database creation
15+
This also comes with an optional ember frontend:
1516

16-
* Database initialization
17-
18-
* How to run the test suite
19-
20-
* Services (job queues, cache servers, search engines, etc.)
21-
22-
* Deployment instructions
23-
24-
* ...
17+
* `cd ./frontend`
18+
* `npm install && bower install`
19+
* `ember s --proxy http://127.0.0.1:3000`

0 commit comments

Comments
 (0)