tdo95/fortunewill

Table of Contents

1. About The Project
   • Features
   • How Its Made
2. Getting Started
   • Installation
   • Usage
3. Optimizations
   • Future Improvements
   • Lessons Learned
4. Roadmap
5. Contact
6. Acknowledgments

About The Project

Curious about what the future has in store for you?

Predict the outcome of current and upcoming events with FortuneWill, a fullstack web application that provides a response to any question you ask.

Features

• Dynamic 3d models and animations
• Question text validation
• Randomized generated responses
• Saves past fortunes accross sessions using local storage

How Its Made

The application is built with the following technologies:

Getting Started

If you would like to use Fortune Will online, visit https://fortunewill.glitch.me/.

To get a local copy of the application up and running follow these simple example steps.

Installation

Follow the steps below to set up the API locally.

1. Clone the repo

   git clone https://github.com/tdo95/fortunewill.git

2. Install NPM packages

   npm install

Usage

1. To start the application server, run the following command

    npm run start  

2. Navigate to the application using the url below

   "localhost:8000"

Optimizations

Future Improvements

• Increase animation rendering speed to reduce loadtime latency - could further compress files
• Use machine learning / language AI to dermine if a fragment of words is a question

Lessons Learned

• How to work with 3d models and animations using three.js library
• Network performance can be optimized by reducing the size of file transfer
• Blocking functions can prevent rendering and inhibit user interaction - this should be avoided when possible
• How to analyze waterfall performance graphs within browser developer tools

Roadmap

• Display 3d model on screen
• build out backend and configure server responses
• Handle long text inputs

Contact

Tee O.

Portfolio: www.github.com/tdo95

(back to top)