Pinbooru is a dead-simple image board, which allows for users to create posts with multiple images attached.
This is my submission for Shopify 2021 fall internship (backend) challenge.
I utilized this Rails+Tailwindcss template by Andy Leverenz.
-
Redis >= 4.0
-
Ruby == 2.7.3
-
First make sure your ruby version matches that in
.ruby-version. And if you don't already use it, check out rbenv, it has saved me from headaches multiple times. -
In the project root, use
bundle installto install the gems needed. -
To get the database all setup, use
bin/rails db:setup -
Next, install the required node modules with
yarn install. -
Run redis in a separate terminal
redis-server, or in daemon mode usingredis-server --daemonize yes -
Run sidekiq in a separate terminal with
bundle exec sidekiq -
(Optional) start webpack development server for compiling assets with
bin/webpack-dev-server -
Finally, you can start the server with
bin/rails s
- Pinbooru is built using Ruby on Rails, and utilizes the Rails' ERB templates for views with StimulusJS & Tailwind CSS to spruce it up.
- Currently Pinbooru is deployed on Heroku on a hobby dyno here: https://pinbooru.amohamed.io/
- For storing the images, I used Active Storage connected to an AWS S3 bucket as its service.
- Lastly, to handle background processes, such as generating thumbnails for uploaded images, Sidekiq was used.
Note-worthy Gems used:
- devise: for authentication
- image_processing: for image resizing for thumbnails
- pagy: for pagination on index page
- aws-sdk-s3: for connecting to the S3 bucket used for image storage.
Pinbooru utilizes Devise for handling authentication.
Currently a non-signed-in user can:
- View index page with all the Posts
- View individual Posts
A signed-in user can, alongside the above, do:
- Creating a new Post with 1 or more images.
- Edit their own Posts by
- Updating the caption
- Removing individual images from a Post
- Add more images to a Post
- Delete their own Posts
For testing, I settled with Rails' built-in testing minitest as it satisfies all of Pinbooru's simple needs.
To test with actual images, there are a couple of fixture images, which can be found at test/fixtures/files/.
All of the tests for Posts can be found in test/controllers/posts_controller_test.rb.
Pinbooru was development in TDD manner. As such most tests were created early on, with changes done depending on controller updates.
There are a total of 13 tests with 29 assertions. Main focus of testing was the basic flow of app & the permissions for each endpoint.
Lastly for CI, I setup a Github Actions workflow to run tests on every push before deployment (auto-deployment is setup through Heroku).
Out of interest, I also looked into adding an API to an existing Rails app. Since it turned out to be rather simple, I created an API for Posts which can be found at app/controllers/api/v1/posts_controller.rb.
The API url path is /api/v1/posts.
This was mostly out of pure curiosity and to learn more about Rails, so there are not separate tests for this API.