Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2.6 KB

README.md

File metadata and controls

67 lines (44 loc) · 2.6 KB

Sudoku Backend

License: MIT

Backend project for Sudoku made using Genkit, and deployed on Vercel.

✨ Checkout the frontend application made using Flutter in this Github Repository.

🚀 Getting Started

To run this project, genkit is required to be installed. Read through the documentation for more information.

npm install -g genkit

The next step is to set-up the environment variables. Checkout the .env.example file and copy the content over to a .env file.

  • The GOOGLE_API_KEY represents the AI API Key that can be created from Google AI Studio.
  • The API_KEY represents a random key used for authorization. The frontend or the client is expected to send this key via x-api-key header.

Read more about Non-Firebase HTTP Authorization in the documentation.

🧩 Run the Server

This project can be run via Genkit Developer UI. To start the UI, use the following command:

genkit start
# or
npm run genkit

Review the documentation for detailed explanation and samples.

Alternatively, this project can be run as an express project. Follow the below commands:

npm run build
npm start

🎯 Deploy

This project is deployed on Vercel.

Checkout the vercel.json file that holds the configurations used for the vercel deployment.

Additionally, go through this official documentation on how to deploy a Firebase Genkit app on any Node.js platform.

✅ Todo Checklist

  • Update generate-hint prompt to make better hints. [In current scenario, sometimes it generates invalid hints (in terms of wrong answer, incorrect cell co-ordinates, less meaningful logic explanations)]
  • Add a better authentication and authorization logic.