Skip to content

kreopelle/film-budget-helper

Repository files navigation

Film Budget Helper

The Film Budget Helper is a Rails App designed to help producers track and organize eligible expenses for applications to New York State’s Empire State Development Film Production Tax Credit, though its basic structure could be used to track expenses and reimbursements for any multi-department project, such as:

  • Weddings
  • Work Trips
  • Conferences
  • Home Renovation

Visit Film Budget Helper to begin using the app, or watch a demo video. To learn more about my process, visit my blog.

Getting Started

This app uses Ruby 2.3.3 and Rails 5.2.1. See deployment for notes on how to deploy the project on a live system.

Installing

Fork and clone this repo. Install the required gems by running

bundle install

Set up the database with

rails db:migrate

Start up the server with

rails s

And find your app at localhost:3000.

To make sure everything is up and running, sign up with a new account. Once signed in, create a new expense to test CRUD functionality.

Deployment

Generate your own client_id and client_secret to use the Google Omniauth features. Follow the steps outlined on the omniauth-google-oauth2 gem page to set it up.

Images are stored using ActiveStorage. For a production environment, set up a connection to a storage service. Follow the steps outlined in the Rails Guides - Active Storage Overview for setup.

Contributors Guide

Bug reports, pull requests, and suggestions are welcome on GitHub at https://github.com/kreopelle/film-budget-helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Film Budget Helper's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

The app is available as open source under the terms of the MIT License.

Acknowledgments

This project was created as part of the Flatiron School's Online Web Development program to fulfill the Rails Portfolio Project requirements, inspired by my previous job as an ultra-low-budget film producer.

Thank you to Dakota, Cernan, Enoch, and the game-of-threads cohort for your guidance and support!

Tip of my hat to the following blogs for walking me through some difficult parts of this build: