murageh / web_gourmet_frontend

Web Gourmet - Frontend

Description

Web Gourmet is a web application that allows users to input a website URL, then proceed to ask any questions they may have about the website. The application will then provide a response to the user's question. The frontend application is built using Next.js and TypeScript. The application leverages the power of AI for the question-answering functionality. This is achieved using the embedded-search capabilities of openAI's GPT models.

Installation

To install the project, you need to have the following installed on your machine:

• Node.js
• npm

Note: The frontend depends on the backend to function properly. Make sure you have the backend running before starting the frontend. The backend code is available at the root directory of the project.

To install the project, follow the steps below:

1. Clone the repository to your local machine.
2. Navigate to the root directory of the project.
3. Run the following command to install the project dependencies:

npm install

Usage

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to view the project.

Contributing (oversimplified 🤣)

To contribute to the project, follow the steps below:

1. Fork the repository.
2. Clone the forked repository to your local machine.
3. Create a new branch for your feature or bug fix.
4. Make your changes.
5. Commit your changes.
6. Push your changes to your forked repository.
7. Create a pull request to the main repository.
8. Wait for your pull request to be reviewed and merged.
9. Celebrate your contribution to the project.
10. Repeat the process for any other contributions you would like to make.

License

This project is licensed under the MIT license. See the LICENSE file for more details.