makersacademy · cvass1 · May 9, 2023 · May 9, 2023 · May 9, 2023 · May 10, 2023
diff --git a/Gemfile b/Gemfile
@@ -11,3 +11,15 @@ end
 group :development, :test do
   gem 'rubocop', '1.20'
 end
+
+gem "pg", "~> 1.5"
+
+gem "rack-test", "~> 1.1"
+
+gem "sinatra", "~> 2.2"
+
+gem "webrick", "~> 1.7"
+
+gem "sinatra-contrib", "~> 2.2"
+
+gem "bcrypt", "~> 3.1"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -3,11 +3,21 @@ GEM
   specs:
     ansi (1.5.0)
     ast (2.4.2)
+    bcrypt (3.1.18)
     diff-lcs (1.4.4)
     docile (1.4.0)
+    multi_json (1.15.0)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pg (1.5.3)
+    rack (2.2.7)
+    rack-protection (2.2.4)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
     rainbow (3.0.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
@@ -36,6 +46,7 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -46,18 +57,38 @@ GEM
       terminal-table
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
+      tilt (~> 2.0)
+    sinatra-contrib (2.2.4)
+      multi_json
+      mustermann (~> 2.0)
+      rack-protection (= 2.2.4)
+      sinatra (= 2.2.4)
+      tilt (~> 2.0)
     terminal-table (3.0.1)
       unicode-display_width (>= 1.1.1, < 3)
+    tilt (2.1.0)
     unicode-display_width (2.0.0)
+    webrick (1.8.1)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
+  bcrypt (~> 3.1)
+  pg (~> 1.5)
+  rack-test (~> 1.1)
   rspec
   rubocop (= 1.20)
   simplecov
   simplecov-console
+  sinatra (~> 2.2)
+  sinatra-contrib (~> 2.2)
+  webrick (~> 1.7)
 
 RUBY VERSION
    ruby 3.0.2p107

diff --git a/README.md b/README.md
@@ -1,123 +1,57 @@
-Chitter Challenge
-=================
+# chitter-challenge
 
-* 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 10am Monday morning
+A Twitter clone built as part of the Makers Academy software development course.
 
-Challenge:
--------
+## Features
 
-As usual please start by forking this repo.
+Users can do the following:
 
-We are going to write a small Twitter clone that will allow the users to post messages to a public stream.
+- Sign up
+- login/logout
+- Post a message (peep) to chitter
+- View all peeps in reverse chronological order
+- See the timestamps on peeps
+- See peeps their tagged in (tagging functionality still in progress)
 
-Features:
--------
+## How to run
 
+```shell
+bundle install
+rackup
 ```
-STRAIGHT UP
 
-As a Maker
-So that I can let people know what I am doing  
-I want to post a message (peep) to chitter
+## Database Structure
 
-As a maker
-So that I can see what others are saying  
-I want to see all peeps in reverse chronological order
+Database Table design template can be found [here](chitter_two_tables_design_recipe.md). The database diagram below is generated by dbdiagram.io using DBML converted from the SQL seed code:
+![db-diagram](./docs/db-diagram.png)
 
-As a Maker
-So that I can better appreciate the context of a peep
-I want to see the time at which it was made
+## Class Design
 
-As a Maker
-So that I can post messages on Chitter as me
-I want to sign up for Chitter
+Ruby Model and Repository class design template can be found [here](chitter_model_and_repository_design_recipe.md).
 
-HARDER
+## Webpage view
 
-As a Maker
-So that only I can post messages on Chitter as me
-I want to log in to Chitter
+![homepage screenshot](./docs/homepage-screenshot.png)
+![userpage screenshot](./docs/userpage-screenshot.png)
 
-As a Maker
-So that I can avoid others posting messages on Chitter as me
-I want to log out of Chitter
+## Pending TODOs
 
-ADVANCED
+- User "tagging" functionality
+- improve CSS design
 
-As a Maker
-So that I can stay constantly tapped in to the shouty box of Chitter
-I want to receive an email if I am tagged in a Peep
-```
-
-Technical Approach:
------
-
-In the last two weeks, you integrated a database using the `pg` gem and Repository classes. You also implemented small web applications using Sinatra, RSpec, HTML and ERB views to make dynamic webpages. You can continue to use this approach when building Chitter Challenge.
-
-You can refer to the [guidance on Modelling and Planning a web application](https://github.com/makersacademy/web-applications/blob/main/pills/modelling_and_planning_web_application.md), to help you in planning the different web pages you will need to implement this challenge. If you'd like to deploy your app to Heroku so other people can use it, [you can follow this guidance](https://github.com/makersacademy/web-applications/blob/main/html_challenges/07_deploying.md).
-
-If you'd like more technical challenge now, try using an [Object Relational Mapper](https://en.wikipedia.org/wiki/Object-relational_mapping) as the database interface, instead of implementing your own Repository classes.
-
-Some useful resources:
-**Ruby Object Mapper**
-- [ROM](https://rom-rb.org/)
-
-**ActiveRecord**
-- [ActiveRecord ORM](https://guides.rubyonrails.org/active_record_basics.html)
-- [Sinatra & ActiveRecord setup](https://learn.co/lessons/sinatra-activerecord-setup)
-
-Notes on functionality:
-------
-
-* You don't have to be logged in to see the peeps.
-* Makers sign up to chitter with their email, password, name and a username (e.g. [email protected], password123, Sam Morgan, sjmog).
-* The username and email are unique.
-* Peeps (posts to chitter) have the name of the maker and their user handle.
-* Your README should indicate the technologies used, and give instructions on how to install and run the tests.
-
-Bonus:
------
+## Built with
 
-If you have time you can implement the following:
+- Ruby
+- Rspec
+- Sinatra
+- PostgreSQL
+- BCrypt
+- Render
 
-* In order to start a conversation as a maker I want to reply to a peep from another maker.
+## Deployment
 
-And/Or:
+Initially deployed on Render (https://chitter-the-chit-chat-app.onrender.com) but is currently inactive.
 
-* Work on the CSS to make it look good.
-
-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/main/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 at this moment.
-
-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 'simplecov'
-require 'simplecov-console'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::Console,
-  # Want a nice code coverage website? Uncomment this next line!
-  # SimpleCov::Formatter::HTMLFormatter
-])
-SimpleCov.start
-```
+## Contact
 
-You can see your test coverage when you run your tests. If you want this in a graphical form, uncomment the `HTMLFormatter` line and see what happens!
+- [Caroline Evans](mailto:[email protected])