Commit 7a9b3fa5 by John Doe

update readme

parent 0a11231f
Showing with 38 additions and 29 deletions
# Lumen API
This is part of the Wattsworth Sensor Network framework.
See `http://wattsworth.net` for details. This code is designed
to support the Lumen Client available at `https://github.com/wattsworth/lumen-client`
## Development Server
To run a local version of the API server do the following:
1. Install the project gems:
$> bundle install
2. Create a development database and a default user
$> rails db:migrate
$> rake local:bootstrap
3. Start the development server
$> rails s
## Testing
Tests are provided with rspec. To execute test suite:
1. Install the project gems
$> bundle install
2. Create a test database
$> RAILS_ENV=test rails db:migrate
3. Run rspec binstub
$> bin/rspec
== README
This README would normally document whatever steps are necessary to get the
application up and running.
Things you may want to cover:
* 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
* ...
Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.
# config valid only for current version of Capistrano
lock "3.8.1"
lock "3.11.0"
set :application, "lumen-api"
set :repo_url, "git@git.wattsworth.net:wattsworth/control-api.git"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment