Station: The Nexmo Developer Gem
Station provides a documentation platform ready to use with your custom documentation.
The documentation for Station covers detailed installation, setup and configuration instructions. Please refer to the documentation as the primary resource for getting started with Station.
- Documentation
- Troubleshooting
- Contributing
- License
Troubleshooting
In the Heroku review app that you'd like a database for, visit More -> Run Console
then run the following command:
cd lib/nexmo_developer/ && bin/rails db:migrate
From the command line execute the following from within the lib/nexmo_developer
folder in Station changing the paths for your local file paths to the API specification and documentation files:
rm -rf public/packs && DOCS_BASE_PATH=/path/to/docs RAILS_SERVE_STATIC_FILES=1 DISABLE_SSL=1 RAILS_LOG_TO_STDOUT=1 OAS_PATH=/path/to/oas/specs RAILS_ENV=production bundle exec rails assets:precompile --trace
Contributing
We ❤️ contributions from everyone! It is a good idea to talk to us first if you plan to add any new functionality. Otherwise, bug reports, bug fixes and feedback on the library is always appreciated. Look at the Contributor Guidelines for more information and please follow the GitHub Flow.
License
This library is released under the MIT License