anacapa-github-prototype

Spike, see: https://www.pivotaltracker.com/n/projects/1519297

Before trying to run this web server, you need to do a few administrative steps with github.com to set up proper credentials.

Set up your Github OAuth Credentials

Before trying to start this web server, you need to create GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET credentials. You will need these later when you create your .env file.

Note that the .env file is NOT saved to github, since it contains secret information. To do that, take these steps:

1. Open this page in a new tab or window (keep this page of instructions open): https://github.com/settings/developers
2. Click "register an application".
3. Fill it in similar to the picture below
4. The callback URL should be http://localhost:3000/users/auth/github/callback

To run this web server:

1. Fork and/or clone this repo
2. Ensure you have postgresql installed and running on localhost
3. Execute bundle install

• If you have a problem installing pg, try running
  • sudo env ARCHFLAGS='-arch x86_64' gem install pg

1. Create a file called .env in the project root,

• You can run cp .env.example .env
• Populate the GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET with your own Github App configurations (see instructions earlier in this README.md)

1. If you are running this for the first time, run rake db:create
2. Execute rake db:migrate
3. Execute rails s
4. The rails server should now be running on http://localhost:3000

To set initial admin:

1. First, sign into your application at http://localhost:3000
2. On the command line in your project root, you can run rake super_admin:help to show all super_admin instructions

169-231-82-184:anacapa-github-prototype johndoe$ rake super_admin:help
 to list all users           rake super_admin:list_users   
 to list all admins          rake super_admin:list_admins   
 to list all non-admins      rake super_admin:list_non_admins   
 to make a user an admin     rake super_admin:grant_admin_permission[< user's id >]   
 to revoke admin privleges   rake super_admin:revoke_admin_permission[< user's id >] 

1. To make yourself an admin, first find yourself by running rake super_admin:list_users

169-231-82-184:anacapa-github-prototype johndoe$ rake super_admin:list_users
+---------------------+----------+----+----------+
| email               | name     | id | is_admin |
+---------------------+----------+----+----------+
| [email protected] | John Doe | 1  | false    |
+---------------------+----------+----+----------+
1 row in set
For syntax of how to grant or revoke admin privs, type rake super_admin:help

1. Find the id corresponding to your user and run rake super_admin:grant_admin_permission[<what you found>]

169-231-82-184:anacapa-github-prototype johndoe$ rake super_admin:grant_admin_permission[1]
+---------------------+----------+----+----------+
| email               | name     | id | is_admin |
+---------------------+----------+----+----------+
| [email protected] | John Doe | 1  | true     |
+---------------------+----------+----+----------+
1 row in set
169-231-82-184:anacapa-github-prototype johndoe$

1. You should now see a link to "Admin Panel" when you sign in to your website.

Database tips

If you have a postgres database console prompt:

• \l to list databases
• \dt to list tables in current database
• \connect database-name to change database