https://github.com/nexmo/station
Ruby gem to start a platform site with specified markdown content
https://github.com/nexmo/station
Last synced: over 1 year ago
JSON representation
Ruby gem to start a platform site with specified markdown content
- Host: GitHub
- URL: https://github.com/nexmo/station
- Owner: Nexmo
- License: other
- Created: 2020-06-18T12:31:20.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T08:12:54.000Z (over 1 year ago)
- Last Synced: 2025-04-09T16:19:48.518Z (over 1 year ago)
- Language: Ruby
- Size: 93.9 MB
- Stars: 11
- Watchers: 10
- Forks: 5
- Open Issues: 138
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Station: The Nexmo Developer Gem
[](CODE_OF_CONDUCT.md)
[](./LICENSE.txt)
Station provides a documentation platform ready to use with your custom documentation.
The [documentation for Station](https://nexmo.github.io/station) covers detailed installation, setup and configuration instructions. Please refer to the documentation as the primary resource for getting started with Station.
* [Documentation](https://nexmo.github.io/station)
* [Troubleshooting](#troubleshooting)
* [Contributing](#contributing)
* [License](#license)
## Troubleshooting
How do I add a database to a review application?
In the Heroku review app that you'd like a database for, visit `More -> Run Console` then run the following command:
```bash
cd lib/nexmo_developer/ && bin/rails db:migrate
```
What do I do if I encounter the ActionView::Template::Error: Webpacker can't find application.js error?
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:
```bash
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 :heart: contributions from everyone! It is a good idea to [talk to us](https://nexmo-community-invite.herokuapp.com/) first if you plan to add any new functionality. Otherwise, [bug reports](https://github.com/Nexmo/nexmo-developer/issues/), [bug fixes](https://github.com/Nexmo/nexmo-developer/pulls) and feedback on the library is always appreciated. Look at the [Contributor Guidelines](CONTRIBUTING.md) for more information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).
## [](https://github.com/dwyl/esta/issues) [](https://GitHub.com/Nexmo/nexmo-developer/graphs/contributors/)
## License
This library is released under the [MIT License][LICENSE]
[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=nexmo-developer
[license]: LICENSE.txt