BackChannelSummer/README at master · jlschuma/BackChannelSummer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
BACK CHANNEL README

-------------------------------------------------------------------------------
TEAM
-------------------------------------------------------------------------------
"Kittens and Rainbows"

Jessica Schumaker: jlschuma@ncsu.edu
Aaron Averill: awaveril@ncsu.edu
Rita Lui: wylui@ncsu.edu

-------------------------------------------------------------------------------
LINKS
-------------------------------------------------------------------------------
Program source: https://github.com/jlschuma/BackChannelSummer
Deployed demo: http://young-water-4826.herokuapp.com/
Development: http://localhost:3000/

-------------------------------------------------------------------------------
TESTING
-------------------------------------------------------------------------------
Our tests used RSpec and Capybara.

To set up test environment, at the project's root directory:

$ bundle install
$ rails generate rspec:install
$ rake db:setup
$ rake db:test:prepare

To run all rspec tests in spec/ directory:

$ bundle exec rspec spec

To run rspec tests in spec/ subdirectory:

$ bundle exec rspec spec/requests
$ bundle exec rspec spec/models
$ bundle exec rspec spec/controllers

To run rspec tests in a specific file:

$ bundle exec rspec spec/models/user_spec.rb

-------------------------------------------------------------------------------
DEVELOPMENT
-------------------------------------------------------------------------------
To start the app:

$ git pull https://github.com/jlschuma/BackChannelSummer.git
$ rake db:setup
$ rails s

You may also start the app via the command:

$ rails s -p port

where port can be specified by the user per project requirements.

-------------------------------------------------------------------------------
TESTING
-------------------------------------------------------------------------------
The db:setup rake task will create a single admin user with the
following credentials:

email: admin@bc.com
password: adminbc

-------------------------------------------------------------------------------
FEATURES FOR EXTRA CREDIT
-------------------------------------------------------------------------------
* Unauthorized access to admin pages are prohibited at controller - no hacking!
* One admin user/password is seeded in database
* A lot of time spent making the UI look nice and modern
* Entering a web address in the post/comment will auto-link
* We used github issue tracker to collaborate - over 22 issues managed
  > https://github.com/jlschuma/BackChannelSummer/issues

-------------------------------------------------------------------------------
NOTES
-------------------------------------------------------------------------------
* There is currently no check for when the last admin user deletes himself or
  changes himself to a non-admin user.
* All test cases were written in RSpec/Capybara syntax. Test cases for model
  validations are in spec/models directory. Test cases for two integration test
  scenarios are in spec/requests directory. Functional tests for controllers
  are in spec/controllers directory. Instead of testing controllers at the
  HTTP request level, we opted to follow RubyOnRails.org's integration approach
  and use RSpec/Capybara to test controllers from a user's perpective.