Question-Craft

About The Project

Question-Craft is a web application that generates questions using the Chat GPT OpenAI API based on user input. It utilizes React and Bootstrap for the frontend and Node.js with Express for the backend.

Table of Contents

• Built With
• Installation
• User Flow
• Configuration

Built With

• Front-end: The front-end of the application is built using HTML, CSS, and JavaScript.

• Back-end: Node.js with Express is used to handle API requests and communicate with the OpenAI API.

• Frameworks and Libraries: The application leverages frameworks and libraries such as React, Express, and Bootstrap to enhance development efficiency and improve user experience.

HTML

CSS

JavaScript

Express

React

Node

Bootstrap

User Flow

Once you have the Question-Craft application set up and running, follow these steps to generate questions:

1. Enter your input text in the provided text input field.
2. Click the "Generate Questions" button.
3. The application will send the input to the backend, which will communicate with the OpenAI API.
4. The generated questions will be displayed on the screen.

Feel free to experiment with different inputs and explore the generated questions!

Installation

git clone https://github.com/Roshanell/question-craft.git

Access project repo

cd question-craft

Remove owner git from the main directory using

rm -rf .git

While still within the main directory in your terminal, run the command git init to start your own git

git init

Access server.js file and install dependencies.

cd server
npm install

Create a .env file in your server file and enter your Auth0 credential.

cd server
touch .env

Open another terminal then cd into the client, install dependencies

cd client
npm install

Start the browser

cd server
npm run dev

Note: Server runs on http://localhost:8080 and client on http://localhost:5173

Configuration

The Question-Craft application requires an OpenAI API key to communicate with the Chat GPT API. Follow these steps to set up your API key:

1. Go to the OpenAI website and sign in to your account (or create a new one).
2. Generate an API key for the Chat GPT API.
3. Copy the API key.
4. In the backend directory of the Question-Craft project, create a .env file.
5. Inside the .env file, add the following line and replace YOUR_API_KEY with your actual API key:

REACT_APP_OPENAI_API_KEY=YOUR_API_KEY