This repository is part of the ongoing development of the Discearn Web App, a project dedicated to improving the online learning experience. The application is designed to provide effective methods for reviewing and synthesizing information from diverse sources. Following an Agile development approach, the project has completed three iterations (25+ user interviews).
To get started, you will need to set up an environment and an API key in Pinecone and generate an OpenAI API key. Please add those to the .env file. The OpenAI API key will be also used for the REACT_APP_API_KEY.
To run the project locally, clone the repository. Then, open two terminals.
In the first terminal, navigate to the client folder and run npm install to install the dependencies. Then, run npm run dev to start the React app.
In the second terminal, navigate to the server folder and run npm install to install the dependencies. Then, run npm start to start the Node server.
The web app should now be running on localhost:3000.
Most notable files and folders:
client: React frontend to display the web app to the user
src: Contains the source code for the React applicationcomponents: Contains the React components used to build the web app-
AddModifyTopicSlide.jsx: Component to modify topicsCard.jsx: Component to display the question and answerChat.jsx: Component to display the discussion with feedbackCopyPasteTextSlide.jsx: Component to upload copy-pasted text into PineconeNavbar.jsx: Component to show the progress of the user.QuestionNavbar.jsx: Component to show the progress of the user in the questions.QuizPage.jsx: The component to hold all the quiz and question information.WelcomeSlide.jsx: Component to give an introduction to the user.
App.js: Main component to render the web app
server: Node backend to run the server allowing connection to Pinecone vector database
server.js: Runs the servercleanup.js: Wipes the Pinecone database