Skip to content

eyecuelab/rational-unicorn

Repository files navigation


By Tyler Bates & Ethan Firpo @ EyeCue Lab


Description

Welcome to Choose Your Venture! A "choose your own adventure" style web application designed to help entrepreneurs and under-represented individuals navigate through and learn about the legal services required to start a business entity.
The user will be prompted a list of options attached to a question on what they're hoping to achieve. The option will have a description of what that legal service is/does and depending on what they choose the user will be provided with additional questions and options. At the end of the guide the user will be displayed information and links to all of the legal services required based on the information they provided throughout the application with the option of either downloading their results or emailing them to Rational Unicorn to further discuss their potential business entity. Check out the application here.


Application Diagrams

App Design

Splash Page First Node Confirmation Modal Results Page Email Confirmation Modal
design panel 1 design panel 2 design panel 3 design panel 4 design panel 5

Legal Service Flow Chart

app design


Logistics

Minimum Product Features
✔️ User is greeted with a splash page
✔️ Clicking on the start button begins the choose your own adventure
✔️ User is prompt with a question and given multiple options
✔️ Clicking on an option opens a modal with a description of the legal service
✔️ User can confirm choice or back out from modal
✔️ Clicking confirm navigates to the next question
✔️ User can go back to previous question resetting last answer
✔️ User is given results at end of application with list of needed legal services
✔️ User can download formatted PDF copy of application results
✔️ User can email application results to designated company email with custom message
✔️ Application has Clean, Responsive UI
✔️ Site is deployed
✔️ Client can update questions/options via Contentful CMS
✔️ Client can add new questions/options via Contentful CMS
✔️ Application automatically re-deploys upon modification to Conentful CMS or Repository Master Branch.


Stretch Goals
Emailed results are handled through SendGrid
Incorporate transitional animations in application UI
Add OAuth to Admin page

Setup/Installation Requirements

For Client/Admin Setup:

  1. Create an account on Contentful's website and access your application's space following these instructions

  2. Once you've navigated to the application's space, you'll be presented with a list of each question and it's options. Clicking on these will give you access to edit all of the properties connected to the selected question/option.

  3. After you've modified your selection simply click the green "Publish Changes" button to the right of the form.

    app design
  4. The application will automatically re-deploy your updates to the live application through Netlify's Continuous Deployment

For Accessing Application Source Code:

  1. Clone this projects repository into your local directory following these instructions.

  2. Open the now local project folder with VSC or an equivalent

  3. If Gatsby isn't already installed globally on your machine, do so by entering the following in the command line:

$ npm install -g gatsby-cli
  1. Navigate to the project directory from your terminal by entering the following:
$ cd ~/rational-unicorn
  1. Within the projects directory install all required dependencies with
$ npm install
  1. Run the application to view in your browser with
$ gatsby develop

If the browser does not automatically launch, view the project here


Known Bugs

There are no known bugs at this time

If you have a bug or an idea, browse the open issues before opening a new one. You can also take a look at the Open Source Guide.


Technologies Used

  • JavaScript
  • React
  • Gatsby
  • Contentful
  • Netlify
  • Reactstrap
  • Styled Components
  • Bootstrap
  • HTML
  • CSS
  • Git

Legal

MIT License

Copyright (c) 2020 Tyler Bates & Ethan Firpo @ EyeCue Lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

EyeCue Lab Internship Summer 2020

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published