Yay Me Post Tracking App

Microposting app for tracking, TILs, merit, praise, and gratitude.

Live on heroku as yayme

Features

• create different types of posts (ex: praise, TIL)
• renders posts in markdown
• takes codeblocks in markdown
• create markdown templates for types of posts

Getting Started

• Fork & Clone
• bundle
• Set up DB: rake db:setup (Runs db:create, db:schema:load and db:seed)
• User: In development, see the seeds file for the user credentials so you can log in
• routes.rb: comment out line 7, uncomment line 10 to allow users to sign up at http://localhost:3000/users/sign_up

Required Technologies

• You will also need a Dropbox account and a dedicated folder in your account for images. At the moment, the image url for posts is highly unsophisticated and is expecting a Dropbox url. If you want to use something other than non-smart url field (like being able to upload photos), go for it! :) You'll have a some work to do in this area.

Tests

• Tests: bundle exec rspec

Linters

This project uses these linters in CI:

• reek
• rubocop
• scss-lint
• FactoryBot.lint -- coming soon

Run them locally on your machine like this:

bundle exec reek

bundle exec rubocop

bundle exec scss-lint app/assets/stylesheets/**.scss

Related Docs

• Devise user authentication (sign up/in/out)
• Pundit user authorization (restricts access to content)
• Uglifier in harmony mode
• Dependabot dependency manager
• Shoulda Matchers for testing model relationships and validations
• FactoryBot to build test objects