Updated readme and license.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <ecds@emory.edu>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+<https://www.contributor-covenant.org/faq>

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2019 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,25 +1,77 @@
-# README
+# OpenTourBuilder API Server
 
-This is the branch for OpenTourBuilder-Server 3.0.
+The OpenTourBuilder API server provides a multi-tenant REST API for geographic tours.
 
-OpenTourBuilder-Server 3.0 is a total rewrite that will add multitenancy.
+## Requirements
 
-Things you may want to cover:
+- Ruby 2.4.1+
+- 5.2.x
+- PostgreSQL 9.6.9
+  - Plugins [^plugins]
+    - pgcrypto
+    - uuid-ossp
+    - plpgsql
 
-* Ruby version
+[^plugins]: Database plugins are enabled during the install process
 
-* System dependencies
+## Build Status
 
-* Configuration
+Waiting to see how this will work with submodules.
 
-* Database creation
+## Installation
 
-* Database initialization
+TODO: How does cloning work with submodules?
+TODO: Note about rbenv.
 
-* How to run the test suite
+~~~bash
+bundle install
+bundle exec rake db:create
+bundle exec rake db:schema:load
+bundle exec rake db:migrate
+~~~
 
-* Services (job queues, cache servers, search engines, etc.)
+## Running local development server
 
-* Deployment instructions
+Run the development under https to avoid mix content errors. Note: this will generate a self-signed certificate. There are ways to tell your browser to trust these certs, but that is beyond the scope of this README.
 
-* ...
+~~~bash
+bundle exec puma -b 'ssl://0.0.0.0:3000?key=<path to key>&cert=<path to cert>
+~~~
+
+## Running tests
+
+TODO: Add test coverage
+
+~~~bash
+bundle exec rspec ./spec
+~~~
+
+## Multitenancy
+
+The OTB API sever uses the [Apartment](https://github.com/influitive/apartment) gem to support multitenancy.
+TODO: Write blog post and link here.
+
+## Endpoints
+
+TODO: List REST endpoints
+
+## Deployment
+
+Use [Capistrano](https://capistranorb.com/) for deployment. General deployment configuration is defined in [deploy.rb](config/deploy.rb). Environment specific configurations can be found in [config/deploy](config/deploy).
+
+Example:
+
+~~~bash
+cap deploy staging
+~~~
+
+## Contribute
+
+We use the [Git-Flow](https://danielkummer.github.io/git-flow-cheatsheet/) branching model. Please submit pull requests against the develop branch.
+
+### Code of conduct
+[Code of Conduct](CODE_OF_CONDUCT.md)
+
+## License
+
+OpenTourBuilder API Server is released under the [MIT License](https://opensource.org/licenses/MIT).