https://github.com/mull/documenty-rails-test
Example app using http://github.com/sorich87/documenty-rails
https://github.com/mull/documenty-rails-test
Last synced: 2 months ago
JSON representation
Example app using http://github.com/sorich87/documenty-rails
- Host: GitHub
- URL: https://github.com/mull/documenty-rails-test
- Owner: mull
- Created: 2012-10-15T10:44:20.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2012-10-15T10:45:03.000Z (over 12 years ago)
- Last Synced: 2024-12-30T23:58:49.397Z (4 months ago)
- Language: Ruby
- Size: 125 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# "Barebones" application to test the documenty-rails gem
Howto:
```
git clone https://github.com/pushly/documenty-rails-test
cd documenty-rails-test
bundle install
```
You will be asked for your login credentials when running bundle install
as the documenty & documenty-rails gems are only available at pushly/ at
this point.
After that is done (use these details):
```
# eml/barebones rails g documenty:install
I need some basic information to create your API documentation.
API name: push.ly JSON REST API
API version: 1
API url: http://0.0.0.0:3000/api
API controller namespace (eg. api/v1): api/business/v1
create config/documenty.yml
```
Then start your rails server in another tab and then generate documenty:
```
rails s
# Switch tab
rails g documenty && open http://0.0.0.0:3000/api
```