-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
29 changed files
with
891 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,21 @@ | ||
source 'https://rubygems.org' | ||
ruby '2.4.0' | ||
|
||
gem 'capybara' | ||
gem 'database_cleaner' | ||
gem 'sinatra' | ||
gem 'pry' | ||
gem 'bcrypt' | ||
gem 'data_mapper' | ||
gem 'sinatra-flash' | ||
gem 'dm-postgres-adapter' | ||
gem 'rack' | ||
|
||
group :test do | ||
gem 'rspec' | ||
gem 'cucumber' | ||
gem 'rake' | ||
gem 'coveralls', require: false | ||
end | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
web: bundle exec rackup config.ru -p $PORT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,108 +1,71 @@ | ||
Chitter Challenge | ||
================= | ||
|
||
* Challenge time: rest of the day and weekend, until Monday 9am | ||
* Feel free to use google, your notes, books, etc. but work on your own | ||
* If you refer to the solution of another coach or student, please put a link to that in your README | ||
* If you have a partial solution, **still check in a partial solution** | ||
* You must submit a pull request to this repo with your code by 9am Monday morning | ||
Write a little Twitter clone that will allow the users to post messages to a public stream. | ||
|
||
Challenge: | ||
------- | ||
|
||
As usual please start by forking this repo. | ||
|
||
We are going to write a little Twitter clone that will allow the users to post messages to a public stream. | ||
|
||
Features: | ||
------- | ||
### User stories for the project: | ||
|
||
``` | ||
As a Maker | ||
As a User | ||
So that I can post messages on Chitter as me | ||
I want to sign up for Chitter | ||
As a Maker | ||
As a User | ||
So that I can post messages on Chitter as me | ||
I want to log in to Chitter | ||
As a Maker | ||
As a User | ||
So that I can avoid others posting messages on Chitter as me | ||
I want to log out of Chitter | ||
As a Maker | ||
As a User | ||
So that I can let people know what I am doing | ||
I want to post a message (peep) to chitter | ||
As a maker | ||
As a User | ||
So that I can see what others are saying | ||
I want to see all peeps in reverse chronological order | ||
As a maker | ||
As a User | ||
So that I can better appreciate the context of a peep | ||
I want to see the time at which it was made | ||
``` | ||
|
||
## To install: | ||
|
||
* Fork this repo & clone to your machine. | ||
* Make sure to have Ruby 2.4 installed for this application. | ||
* Run bundler to install gems. (You may also need to bundle update) | ||
* Run RSpec to view or test drive new features. | ||
* Run Rackup and type in browser your localhost address to start using the application. | ||
* Follow the app structure below as a guide to the application structure. | ||
|
||
![Sign in](https://raw.githubusercontent.com/j-rods/chitter-challenge/master/readme-assets/1.png) | ||
|
||
|
||
![Hub](https://raw.githubusercontent.com/j-rods/chitter-challenge/master/readme-assets/2.png) | ||
|
||
## Technologies used: | ||
|
||
* Ruby 2.4 | ||
* Sinatra | ||
* RSpec | ||
* Heroku | ||
* Capybara | ||
* Rack | ||
* DataMapper | ||
* SQL | ||
* BCrypt | ||
* Sinatra-Flash | ||
* Database-Cleaner | ||
* HTML5 | ||
* CSS3 | ||
|
||
Notes on functionality: | ||
------ | ||
|
||
* Drive the creation of your app using tests - either cucumber or rspec as you prefer | ||
* Makers sign up to chitter with their email, password, name and a user name (e.g. sam@makersacademy.com, s3cr3t, Samuel Russell Hampden Joseph, tansaku). | ||
* Users can sign up to chitter with their email, password, name and a user name (e.g. test@gmail.com, s3cr3t, Samuel Russell Hampden Joseph, tansaku). | ||
* The username and email are unique. | ||
* Peeps (posts to chitter) have the name of the maker and their user handle. | ||
* Use bcrypt to secure the passwords. | ||
* Use data mapper and postgres to save the data. | ||
* Peeps (posts to chitter) have the name of the user and their user handle. | ||
* You don't have to be logged in to see the peeps. | ||
* You only can peep if you are logged in. | ||
* Please ensure that you update your README to indicate the technologies used, and give instructions on how to install and run the tests | ||
* Finally submit a pull request before Monday at 9am with your solution or partial solution. However much or little amount of code you wrote please please please submit a pull request before Monday at 9am | ||
|
||
Bonus: | ||
----- | ||
|
||
If you have time you can implement the following: | ||
|
||
* In order to start a conversation as a maker I want to reply to a peep from another maker. | ||
|
||
And/Or: | ||
|
||
* Work on the css to make it look good (we all like beautiful things). | ||
|
||
Good luck and let the chitter begin! | ||
|
||
Code Review | ||
----------- | ||
|
||
In code review we'll be hoping to see: | ||
|
||
* All tests passing | ||
* High [Test coverage](https://github.com/makersacademy/course/blob/master/pills/test_coverage.md) (>95% is good) | ||
* The code is elegant: every class has a clear responsibility, methods are short etc. | ||
|
||
Reviewers will potentially be using this [code review rubric](docs/review.md). Referring to this rubric in advance may make the challenge somewhat easier. You should be the judge of how much challenge you want this weekend. | ||
|
||
Notes on test coverage | ||
---------------------- | ||
|
||
Please ensure you have the following **AT THE TOP** of your spec_helper.rb in order to have test coverage stats generated | ||
on your pull request: | ||
|
||
```ruby | ||
require 'coveralls' | ||
require 'simplecov' | ||
|
||
SimpleCov.formatters = [ | ||
SimpleCov::Formatter::HTMLFormatter, | ||
Coveralls::SimpleCov::Formatter | ||
] | ||
Coveralls.wear! | ||
``` | ||
|
||
You can see your [test coverage](https://github.com/makersacademy/course/blob/master/pills/test_coverage.md) when you submit a pull request, and you can also get a summary locally by running: | ||
|
||
``` | ||
$ coveralls report | ||
``` | ||
|
||
This repo works with [Coveralls](https://coveralls.io/) to calculate test coverage statistics on each pull request. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,24 @@ | ||
if ENV['RACK_ENV'] != 'production' | ||
require 'rspec/core/rake_task' | ||
|
||
RSpec::Core::RakeTask.new :spec | ||
|
||
task default: [:spec] | ||
end | ||
|
||
require 'data_mapper' | ||
require './app/app.rb' | ||
|
||
namespace :db do | ||
desc "Non destructive upgrade" | ||
task :auto_upgrade do | ||
DataMapper.auto-upgrade! | ||
puts "Auto-upgrade complete (no data loss)" | ||
end | ||
|
||
desc "Destructive upgrade" | ||
task :auto_migrate do | ||
DataMapper.auto_migrate! | ||
puts "Auto-migrate complete (data was lost)" | ||
end | ||
end |
Oops, something went wrong.