watermarkchurch/coding-challenge

A template rails app that can be used for Watermark's coding challenge

WM Coding Challenge

This repository contains a template Rails app that has been pre-configured using many of our favorite gems for development and testing. We've already debugged the configuration issues associated with a new rails app, to allow you to focus on the actual thing we're trying to assess with this coding challenge.

You are not required to use this template to complete the coding challenge, and it will not count against you whether you do or don't! If you prefer to init your own rails app from scratch be free!

Getting Started

There are two ways to go about developing using this template, using docker or standard "rails s"

Using Docker

1. install Docker Desktop, following the Getting Started guide.
2. run docker compose up in the root of the directory
3. Navigate to http://localhost:3000

Using standard "Rails s"

1. Install Ruby version 3.0.1 or higher

• Our developers use rbenv to install particular ruby versions, but you can install it any way you'd like

2. install Bundler v2.2.17 or higher

• `gem install bundler -v2.2.17

3. Run bundle install
4. Install node and NPM
5. using NPM, install Yarn

• npm install --global yarn

6. run bundle exec rails s
7. Navigate to http://localhost:3000

Running tests

use bundle exec rspec to run RSpec tests. In this template there are no tests yet, you'll have to add them!

You can also use Guard to automatically watch files and re-run tests whenever they change. Do this with bundle exec guard.

Submitting your code

If you chose to use this template for your coding challenge, please submit your work by forking this repository and sending a pull request.

If you chose to create your own rails app from scratch, please submit your work by creating a new git repository and emailing us a link to it.

Hint

Your next step should probably be to use Rails' scaffold generator to generate your Message model and controllers.
bundle exec rails g scaffold Message

Checklist

• The homepage (path /) SHALL present a list of messages from the database
• The homepage SHALL provide a link to a form to upload a new message
• The new message page SHALL accept a mp4 file upload
• The new message page MAY accept an additional jpeg or PNG file upload as a thumbnail image
• The new message page SHALL accept the following textual inputs:
  • Title
  • Description
• The new message page SHALL allow associating the message to any number of tags.
• New tags SHALL be created automatically upon submitting the new message form.
• The new message page SHALL have a Submit button which creates the new message.
• The new message page SHALL have a Cancel button which discards the new message.
• The new message page SHALL validate that title exists, rejecting the submission if validation fails.
• On validation failure, the new message page SHALL display an appropriate error message.
• On validation success, the new message page SHALL redirect to the homepage.
• The homepage SHALL display the newly created message in the list upon successful submission
• The homepage MAY display the thumbnail image alongside the newly created message as an HTML img tag
• The homepage SHALL provide a link to edit the message
• The edit message page SHALL accept the following textual inputs:
  • Title
  • Description
• The edit message page SHALL allow adding new tags to the message or deleting tags from the message.
• New tags SHALL be automatically created when the edit form is submitted.
• The edit message page MAY allow replacing the thumbnail image or mp4 video file
• The edit message page SHALL have a Submit button which creates the new message.
• The edit message page SHALL have a Cancel button which discards the in-progress edit.
• The edit message page SHALL validate that title exists, rejecting the submission if validation fails.
• On validation failure, the edit message page SHALL display an appropriate error message.
• On validation success, the edit message page SHALL redirect to the homepage
• All HTML pages in the application SHOULD have a consistent style and use a grid system (e.g., Bootstrap, Flexbox, CSS grid)
• The application SHALL expose an API endpoint to query messages from the database
• The API query endpoint SHALL respond with the application/json content type
• The API query endpoint SHALL accept the ?tag= HTTP query parameter to filter messages by tag
• When filtering messages by tag, the API query endpoint SHALL only include messages matching the provided tag
• The API query endpoint’s response SHALL include the following in JSON format for each message:
  • Title
  • Description
  • Tag
  • URL
• The above URL SHALL cause the browser to play (NOT download) the uploaded MP4 video when copy-pasted out of the API response into the URL bar.
• The API query endpoint’s response MAY include the following additional fields:

• thumbnail image URL

• The above thumbnail image URL, if included, SHALL result in an image being displayed when used as the “src” attribute in an HTML image element
• The application MAY contain a suite of unit tests, and instructions on how to execute them. Note: these tests need not be exhaustive, but there should be at least 1. You decide how many tests you want to include.