Move around + clean up documentation (#67)

* move the contribution docs, update stale links, and add missing information.
* address feedback
* organize contribution guide for portal
* switch to 8000

Author: natalysheinin

CONTRIBUTING.md

@@ -1,21 +1,90 @@
-# Contributing
+# Contributing Guidelines
 
-Thank you for considering contributing to COVID Shield!
+Welcome, and thank you for considering contributing to COVID Shield!
 
 We’d love to get your issues (if you find any bugs) and PRs (if you have any fixes)!
 
+- [Code of Conduct](#code-of-conduct)
+- [Reporting Security Issues](#reporting-security-issues)
+- [Contributing](#contributing)
+  - [Contributing Documentation](#contributing-documentation)
+  - [Contributing Code](#contributing-code)
+- [Running COVID Shield](#running-covid-shield)
+  - [From Scratch](#from-scratch)
+
+## Code of Conduct
+
 First, please review this document and the [Code of Conduct](CODE_OF_CONDUCT.md).
 
-## Contributing documentation and non-code changes
+## Reporting Security Issues
+
+COVID Shield takes security very seriously. In the interest of coordinated disclosure,
+we request that any potential vulnerabilities be reported privately in accordance with
+our [security policy](SECURITY.md).
+
+## Contributing
+
+### Contributing Documentation
 
 If you'd like to contribute a documentation or static file change, please
-feel free to fork the project in Github and open a PR from that fork against
-this repository.
+feel free to fork the project in Github and open a PR from that fork against this repository.
+
+### Contributing Code
 
-## Contributing code
+If you'd like to contribute code changes, the following steps will help you
+setup a local development environment. If you're a Shopify employee, `dev up`
+will install the above dependencies and `dev {console,test,etc.}` will work
+as you'd expect.
 
-If you'd like to contribute code changes, please first setup a local development
-environment following [the steps outlined in the README](README.md#local-development). 
+If you're not at Shopify, please see below.
 
 Once you're happy with your changes, please fork the repository and push your
 code to your fork, then open a PR against this repository.
+
+## Running COVID Shield
+
+### From Scratch
+
+#### Prerequisites
+
+The setup steps expect the following tools to be installed on the system:
+
+* [Ruby](https://guides.rubyonrails.org/getting_started.html#installing-ruby)
+* [MySQL](https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/)
+* [Node.js](https://guides.rubyonrails.org/getting_started.html#installing-node-js-and-yarn)
+* [Rails](https://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project-installing-rails-installing-rails)
+* [COVID Shield Diagnosis Server](https://github.com/CovidShield/server)
+
+#### Running
+
+1. Check out the repository
+
+```bash
+git clone git@github.com:CovidShield/portal.git
+```
+
+2. Update database.yml file
+
+Update the database.yml file with your MySQL configuration as required.
+
+3. Create and set up the database
+
+Run the following commands to create and set up the database.
+
+```ruby
+bundle exec rake db:create
+bundle exec rake db:setup
+bundle exec rake db:seed
+```
+
+4. Start the Rails server
+
+You can start the rails server using the command given below (replacing the KEY_CLAIM_HOST to match your running diagnosis server config).
+
+```ruby
+KEY_CLAIM_HOST=localhost:8000 bundle exec rails s
+```
+
+And now you can visit the site with the URL http://localhost:8000
+
+The default username and password is `admin@covidshield.app` and `password`.

README.md

@@ -15,115 +15,9 @@ The use of this portal is optional and you can easily integrate the code creatio
 - [Design files on Figma](https://www.figma.com/file/b76OYDhkTKJCaqDfVQybQY/Open-Source-COVID-Shield?node-id=68%3A167)
 - [Glossary of terms](https://github.com/CovidShield/rationale/blob/master/GLOSSARY.md)
 
-## Local development
+## Contributing
 
-### Prerequisites
-
-The setup steps expect the following tools to be installed on the system:
-
-- [Ruby](https://guides.rubyonrails.org/getting_started.html#installing-ruby)
-- [Rails](https://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project-installing-rails-installing-rails)
-- [MySQL](https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/)
-- [Node.js](https://guides.rubyonrails.org/getting_started.html#installing-node-js-and-yarn)
-- [Webpack](https://github.com/webpack/webpack#install)
-- [Yarn](https://yarnpkg.com/getting-started/install#global-install)
-- [COVID Shield Diagnosis Server](https://github.com/CovidShield/server)
-- [Docker/Docker Compose](https://docs.docker.com/get-started/#set-up-your-docker-environment)
-
-### Check out the repository
-
-```bash
-git clone git@github.com:CovidShield/portal.git
-```
-
-### Install dependencies
-
-```bash
-# If you don't have the bundler gem, do this next line too:
-# gem install bundler
-
-bundle install
-```
-
-On MacOS, you may get issues installing the `mysql2` Gem. If you have [Homebrew](https://brew.sh/), you can install it this way:
-
-```bash
-brew install mysql openssl
-gem install mysql2 -- --with-cflags=\"-I/usr/local/opt/openssl@1.1/include\" --with-ldflags=\"-L/usr/local/opt/openssl@1.1/lib\"
-bundle install
-```
-### (Optional) Create a new MySQL Database using Docker
-
-If you don't already have a local MySQL database, you can create one easily.
-
-First, create a directory for the local data storage:
-
-```bash
-mkdir mysql-data
-```
-
-Second, start the database using Docker:
-
-```bash
-docker run -it --rm -p 3306:3306 --name portal-db -v $PWD/mysql-data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=stayhealthy -d mysql
-```
-
-This will create a database with the following properties:
-
-- IP: `127.0.0.1`
-- Port: `3306`
-- User: `root`
-- Password: `stayhealthy`
-
-To kill it later, use:
-
-```
-docker kill portal-db
-```
-
-### Update database.yml file
-
-Update the [database.yml](config/database.yml) file with your MySQL configuration as required.
-
-If you're using the Docker-based MySQL from the above section, your `default` section will look like this:
-
-```yaml
-default: &default
-  adapter: mysql2
-  encoding: utf8mb4
-  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
-  username: root
-  password: stayhealthy
-  host: 127.0.0.1
-```
-
-### Create and set up the database
-
-Run the following commands to create and set up the database.
-
-```ruby
-bundle exec rake db:create
-bundle exec rake db:setup
-bundle exec rake db:seed
-```
-
-### Start the Webpack Server
-
-Open a new terminal window, navigating into the base of the repo, and start the Webpack server:
-
-`./bin/webpack -w`
-
-### Start the Rails server
-
-You can start the rails server using the command given below (replacing the KEY_CLAIM_HOST to match your running diagnosis server config).
-
-```ruby
-KEY_CLAIM_HOST=127.0.0.1:8000 bundle exec rails s
-```
-
-And now you can visit the site with the URL http://localhost:3000
-
-The default username and password is `admin@covidshield.app` and `password`.
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## Who built COVID Shield?
 

SECURITY.md

@@ -0,0 +1,6 @@
+# Security Policy
+
+COVID Shield takes security seriously. If you have found a security vulnerability
+in any of the software within this GitHub organization, please **DO NOT** create
+a public issue. Instead, send a detailed report to security@covidshield.app. We endeavour
+to respond to all security-related emails within 7 days.