Introduction

👋 Welcome to the ai-crosswords repository!

This document serves as a guide to get your local development environment up and running in as little time and headache as possible.

Tech Stack

📃 Language: Typescript & React

💻 Framework: NextJS

💅 Styling: Tailwindcss

☁️ Hosting: Vercel

Installation

Prerequisites

1. An IDE of your choice, VSCode is recommended

2. Node.js (LTS version)

3. A package manager, pnpm is recommended

4. An OpenAI API key

Setup local environment

1. Clone the repository and install the dependencies:

git clone https://github.com/Seth-McKilla/ai-crossword.git
cd ai-crossword
pnpm install

2. Rename the .env.example file to .env and add your OpenAI API key:

mv .env.example .env

3. Run the local development environment:

pnpm dev

Navigate to http://localhost:3000 to see the app running in your browser.

That's it! Happy coding 😀