Skip to content

README DRAFT

Francesca Sadikin edited this page Sep 24, 2019 · 13 revisions

Imgur

Focal is a workflow and client management tool for wedding photographers. It aims to help a photographer consolidate a clients information (personal info, photography packages, shoot events, and private notes) and tie it to a set of workflow tasks.

Future features would include integrating third party services like Google Gmail, Google Calendar or Stripe to reduce context switching for the users. For example, the app would be able to send emails, update their calendars, or send invoices directly from the workflow tasks.

The project is built in React and works with a Elixir/Phoenix API. Other dependencies include react-testing-library, formik, date-fns, axios, sass, react-router, moment, jest. Note that the project is hosted on Heroku free-plan which has slow spin up times -- Please give it a few seconds to load.

Features

  • Google Authentication
  • Create & Update Client Information
  • Create & Update Client Packages
  • Create & Update Client Events
  • Auto Generated Workflows Tied to Client Packages with Todo-style Task Completion.
  • All Clients View with a List of the Current Task for All Clients

Feature Walkthroughs

Local Development Setup

git clone https://github.com/Focal-App/focal.git
cd focal
npm install
npm start // in one terminal
npm test // in a second terminal

Deploying Master

git push heroku master --force

Deploying Non-Master branch

git push origin/<branch name>:master --force

Clone this wiki locally