- About
- How to install (on local system) *requires GitHub OAuth
- Contributor's guide
- License
RoR Newsroom as a platform focuses on the publishing workflow found in a multi-person, news-producing venture. Since this is a school project, I kept the workflow and the authorizations very simple. There are anonymous users (without accounts), and employees( those with accounts). I am using the following workflow to model the behavior of RoR Newsroom:
- New idea or a pitch
- Approval to proceed
- Assignment of an idea to an author
- Working draft
- Editorial review of draft (and sent back to step 4 if revisions are needed)
- Publish live news article
- The platform also allows for updates to be attached to published articles.
- Download or clone this repo.
- Open terminal to the top level directory of this project and type
bundle install - Type
rails db:migrateto install the sqlite database (will be found at ./db/development.sqlite3) - Populate database with demo content by typing
rails db:seed. - Register a new OAuth app with Github at developer settings
- Go to link above then click on the OAuth Apps vertical tab.
- Click "New OAuth App"
- Give it a meaningful name like "RoR Newsroom"
- Set the homepage URL to
http://localhost:3000/ - Set the Authorization callback URL to
http://localhost:3000/auth/github/callback - Fill in the rest of the information as you deem fit.
- Start the rails server by typing
rails s - Open
localhost:3000in a new browser window and start interacting with RoR Newsroom!
Bottom line: I will be a kind human. Please be the same in return.
Please submit a contribution idea through an issue ticket before working on a pull request. Don't submit a pull request unless it has been discussed through an issue ticket. I happily respond to all contructive inquiries.
As this project evolves, I will update this readme and how contributions are accepted.