Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.16 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.16 KB
Raw

City Kids Tour Guide

Welcome to City Kids Tour Guide, a project aimed at creating interactive city tour guides for kids, allowing their parents or guardians to read them stories while exploring the city. This project utilizes Next.js and TypeScript to provide a seamless and engaging experience for families.

Introduction

City Kids Tour Guide is designed to make city exploration fun and educational for children. By integrating storytelling with guided tours, parents can enhance their children's understanding of local landmarks, culture, and history while fostering a sense of adventure and curiosity.

Features

  • Interactive Storytelling: Engage children with captivating stories tailored to specific locations within the city.
  • Customizable Tours: Create personalized tours based on the interests and preferences of the family.
  • Real-time Text Generation: Utilize OpenAI's API to generate dynamic text content, providing fresh and relevant storytelling experiences.
  • Next.js and TypeScript: Leverage the power of Next.js for server-side rendering and TypeScript for type safety and scalability.

Getting Started

To get started with City Kids Tour Guide, follow these steps:

  1. Clone the repository to your local machine:
git clone https://github.com/Kapple14/KiddyGuide.git
  1. Install dependencies
cd city-kids-tour-guide
npm install

Setup OpenAI API

To set up the OpenAI API, follow these steps:

  1. Sign up for an API key at OpenAI.
  2. Add your API key to the project configuration.

Running the Development Server

To run the development server, execute the following command:

npm run dev

Explore the Application

Explore the application in your web browser by navigating to:

http://localhost:3000

Contributing

Contributions to Kiddy Guide are welcome! Whether you're interested in adding new features, fixing bugs, or improving documentation, your contributions help make this project better for everyone.

Support

If you have any questions, feedback, or need assistance, please don't hesitate to open an issue. We're here to help!

Happy exploring with Kiddy Guide! 🌆👨‍👩‍👧‍👦