'Chitter' is the weekend challenge after the fourth week at Makers Academy Bootcamp. It is a small Twitter clone that will allow the users to post messages to a public stream.
This project was a stretch challenge to develop on my software development skills. It implements pretty much all the skills intensively taught so far on the Makers course, including the construction of a web app, with attached database via TDD methodology. It will be a significant challenge to complete. I would like to get better at TDD'ing HTTP routes, in a RESTful way, I am currently not very confident in TDD'ing capybara, this is practice to get me better at it.
The project is currently under construction, it may not be completed as this is a practice exercise to build on my skills.
Currently i need to get the peeps into the main SQL database and out again into the view to show them on the '/peeps' route. I think i need to use params to do this. Have not really flogged myself hard this weekend as have burnt myself out on prior mondays after a weekend challenge.
Although I drew routes on paper they are not included here.
-
As a Maker So that I can let people know what I am doing
I want to post a message (peep) to chitter -
As a maker So that I can see what others are saying
I want to see all peeps in reverse chronological order -
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
-
As a Maker So that I can post messages on Chitter as me I want to sign up for Chitter
HARDER
As a Maker So that only I can post messages on Chitter as me I want to log in to Chitter
As a Maker So that I can avoid others posting messages on Chitter as me I want to log out of Chitter
ADVANCED
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
Bonus: if i get time.
As a Maker In order to start a conversation as a maker I want to reply to a peep from another maker.
An apple macbook was used to write code using VSCode as an editor and;
- Ruby was used as the main language. =
- RSpec used for testing.
- PG gem was used to integrate SQL database with Ruby.
- Capybara was used for testing.
- HTML and CSS.
An Object Relational Mapper will be used as the database interface if I get time to implement.
Rubocop 0.65.0 was used for linting and stylying the Ruby code.
A TDD process was used in the development of this project, please see the attached RSpec files for details of the testing that was carried out.
Ruby v 2.5.0 was used in the construction of the project, if gems were used, please find attached a gem file listing those gems for installation.
No API used in this project.
You should be able to run the code via irb.
## Notes
Some useful resources: DataMapper
ActiveRecord
- 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. samm@makersacademy.com, 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.
Opening a pull request against this repository will will trigger Travis CI to perform a build of your application and run your full suite of RSpec tests. If any of your tests rely on a connection with your database - and they should - this is likely to cause a problem. The build of your application created by has no connection to the local database you will have created on your machine, so when your tests try to interact with it they'll be unable to do so and will fail.
If you want a green tick against your pull request you'll need to configure Travis' build process by adding the necessary steps for creating your database to the .travis.yml file.
Full credit given to Makers Academy who suggested the project.
No contributions are required at this time, as this is a training exercise.