Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 4.29 KB

README.md

File metadata and controls

97 lines (64 loc) · 4.29 KB
Raw

Betwixt

Overview

Betwixt is a web application that lets users read, like and publish stories; as well as follow other authors. Inspired by Medium.

Homepage

Background

I made this back when I was at App Academy. It was my first run at creating a solo full stack application. I was pretty pleased with the results. It was a Medium clone so I tried to style it similar to Medium. Obviously nowhere near as good looking. The project hasn't been kept up, but it is still live.

I haven't worked on this since 2018 so I don't have a whole lot more to say or add. Just a fun project to see my evolution as a web developer and see where it all started.

Installation

Requirements

Setup

  git clone https://github.com/gabrieltal/betwixt.git
  cd betwixt
  bundle exec rails db:setup
  bundle install

To start the server locally:

  rails server
  npm run start

Features

User Authentication

  • Users can create accounts, log in and out
  • User created stories are featured on their profile pages
  • User number of followers and following are also featured on their website

Story creation

  • Users can create stories using React-Quill This allows the user to set headers, images as well as bullet points and list elements in the stories they create.
  • Users can edit their stories and the edit date will also be reflected on the site allowing users to know when the story was edited
  • Users can also upload their own header images as well as edit their own custom profile pictures. The photos are retrieved using AWS and uses Paperclip as a file attachment for the Rails backend.

Follows

  • When users begin following users their main feed will first be populated with stories from users they follow
  • Users can follow other users from the main page or on their profile page or when reading one of their stories

Likes

  • Users can like content and see stories other users have liked on the user show page

Homepage

User Show Page

  • Users are able to see what content they have liked and are able to click on the story liked and go into the story show page
  • Users are able to see content other users have commented on by going to that user show page and are able to click to see what story it was they commented on
  • Users are able to view stories other users have written on the specific user show page

Utilizing custom routes on the backend

In order to avoid making additional calls to the backend in order to do simple tasks such as unliking content or unfollowing someone; which usually using the rails boilerplate routes you would need to hold the id for the Like or Follow. I wanted to keep a clean state and not hold an id I wouldn't really need in most cases. My stories only need to hold the user ids for users who have liked it. My users only need the story id for the stories they like. To avoid carrying the Like id I created a custom route to send the story id and the user id and in the backend I found the like based off those two ids and accomplished the unliking in the backend.

  # app/controllers/likes_controller.rb
  @like = Like.find_by_user_id_and_story_id(params[:user_id], params[:story_id])
  if @like
    @like.destroy
  end

  # config/routes.rb
  delete 'api/likes/:user_id/:story_id', :to => 'api/likes#destroy'

Additional Resources

TODOs

  • Better organize stories on the front page, i.e. featured stories
  • Implementation of editing, deleting and liking comments
  • Allow saving of drafts of stories so users can come back to finish their works at a later date