Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hrishimittal committed Aug 18, 2017
1 parent ddfcd12 commit 0e37bda
Showing 1 changed file with 4 additions and 21 deletions.
25 changes: 4 additions & 21 deletions README.md
@@ -1,24 +1,7 @@
# README
# Idea Board API

This README would normally document whatever steps are necessary to get the
application up and running.
An Idea board app built as a Rails 5.1 API app, based on the [Rails 5 API and React.js tutorial - How to make an Idea board app](https://learnetto.com/tutorials/rails-5-api-and-react-js-tutorial-how-to-make-an-idea-board-app).

Things you may want to cover:
The app has API endpoints for adding, editing and deleting ideas.

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
See this [React frontend app code](https://github.com/learnetto/ideaboard) to talk to this API.

0 comments on commit 0e37bda

Please sign in to comment.