Skip to content

Vivid-Project/frontend

Repository files navigation

VIVID Project - Frontend

Vivid Splash

Contributors Stargazers Issues

VIVID is currently under development. If you'd like to contribute, submit a PR to our team with the built in template!


Table of Contents


Project Overview

What are your dreams telling you?

VIVID is a full-stack collaborative project built completely from scratch by our team at Turing School of Software & Design.

Use VIVID to log your dreams and receive back an analysis of unique tones inside of them. Track these tones over time with interactive charts detailing the frequency of your emotions over time.

As a Progressive Web Application, Vivid is fully reactive and ready to be used as an application on your mobile device without needing to install anything. (See the installation section for more details)

Visit the VIVID backend to explore possible API endpoints and a more in depth view of the dark side.


Installation

Note: VIVID works best on mobile!

Mobile:

Navigate to our live site at https://vivid-project.herokuapp.com/ with your mobile device. (Note: You may have to wait for Heroku to load. If you receive an error message from Heroku, reload the page and the app will be displayed. This is due to the free tier hosting)

Once you reach the login screen, add the site to your home screen. You can find a helpful article explaining how to that here.

Launch Vivid from your home screen. It now functions exactly like an application!

Desktop:

In your console, navigate to a directory you want to download the repo to and type

$ git clone git@github.com:Vivid-Project/frontend.git

Navigate into the new directory

$ cd frontend/

Install dependancies

$ npm install

Start the application

$ npm start

Navigate to http://localhost:3000/ in your browswer to use the application!

Alternatively, navigate to the deployed site at https://vivid-project.herokuapp.com/ (Note: You may have to wait for Heroku to load. If you receive an error message from Heroku, reload the page and the app will be displayed. This is due to the free tier hosting)

Logging In:

Login as an existing user, or create your own account. You may have to wait for the Heroku backend to start up. Logins for existing users are below:

user: mjones@example.com

password: password

user: adrew@example.com

password: password


Features

The Dashboard Overview

dashboard

  • Interactive dashboard featuring dream emotions over time, and frequency of emotions during the same period.
  • Users can disable/enable different emotions to focus on and change the charting data timeframe.

The Dream Input

dashboard

  • Users can add their own unique dreams to their dream journal...

The Dream Journal

dashboard

  • ... and can then retrieve the emotions contained inside of those dreams from the dream journal.

Additional Features:

  • Vivid will allow you to navigate the application offline, and lets you know if you lose connectivity:

dashboard

Technologies And Tools

  • JavaScript (ES6)
  • React
  • JSX
  • Material UI
  • CSS
  • React-Router
  • Chart.js
  • Jest, unit testing
  • Cypress, for integration testing
  • Circle CI, for continuous integration
  • Heroku for deployment

Challenges

  • Designing, building, and testing an entire full stack application from scratch

Wins

  • Entirety of project was built in 12 days
  • Explored and learned PWA technology, including service workers and offline caching
  • Successfully integrated Cypress testing for the first time
  • Collaborated with Backend Engineers to create custom endpoints to utilize

Roadmap

  • Add ability for new user sign up
  • Ability to delete past dreams
  • Addition of user created tags, that are then searchable

Credits

Front End:


Amanda Davidson

Amanda Davidson - GitHub Profile - LinkedIn - Turing Alum Profile

Shawn Truesdale

Shawn Truesdale - GitHub Profile - LinkedIn - Turing Alum Profile

Back End:


Jonathan Wilson

Jonathan Wilson - GitHub - LinkedIn - Turing Alum Profile

Zach Stearns

Zach Stearns - GitHub - LinkedIn - Turing Alum Profile

Aidan Murray

Aidan Murray - GitHub - LinkedIn

Taylor Phillips

Taylor Phillips - GitHub - LinkedIn - Turing Alum Profile

About

Vivid - Your Dreams, Decoded.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •