CrashCourse is an IOS mobile App powered by OpenAI API that summarizes Google and Wikipedia search results for one's easy viewing. Type in whatever general knowledge term you want to understand, and in a matter of few seconds, you can find the most important topics/questions that are digestible in 4 minutes or less about the topic on your app!
The first iteration of this project was completed in 3 days including idea generation. Part of HackReactor Program “MVP” project.
Created animation for splash screen that renders the search bar for user input after static assets are loaded. Users can then search for any terms they would like a CrashCourse on. The app will redirect them to Summary Tab after key points and related words are loaded from API.
Users will see 5 key points about the searched term and 9 - 12 clickable related words. When clicked on any of the related words, app will conduct the same search via calls to API for content generation. User will be redirected to Summary screen for new search word once content is loaded.
Users can utilize the bottom navigation to check out a detailed description, including major milestones and accomplishments if applicable, and other random facts about the searched term. The content generation of these tabs is done in the background when the Summary page is rendered.
The story tab has an Open AI generated first person POV narrative for entertainment value. Animated a typewriter effect so the user has an experience of listening to a story. Users can stop the typing animation and view the whole story anytime by clicking on "finish typing". Users can navigate back to the search screen in any of the tabs for additional searches.
- Clone the repo
git clone https://github.com/andylin1212/CrashCourse.git
- Install all required packages in both client and server folders
npm install
- Create a .env file in the server folder
- Create an Open AI API key and add that to the .env file with below format
OPENAI_API_KEY = [your personal OpenAI API Key]
- Compile the client-side code and start Metro Bundler
npm start
- Scan the QR code from Metro Bundler in Terminal
- Start the server
npm run server-dev