Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.01 KB

README.md

File metadata and controls

74 lines (50 loc) · 3.01 KB
Raw

101.school

101.school is a platform that utilizes AI, particularly GPT-4, to create detailed and captivating course materials tailored to user inputs.

This project's goal is to explore how AI can be used to assist learning and education.

101.school screenshot

Features

  • AI-generated course outlines and content
  • User account management for accessing certain features
  • Email notifications for course updates
  • Publicly accessible generated courses
  • Interactive AI chat for inquiries on course units

Technologies Used

  • Next.js for the frontend and backend framework
  • TypeScript for type-safe code
  • OpenAI's GPT-4 for generating course content
  • PostgreSQL for database management
  • Vite for frontend tooling
  • Tailwind CSS for styling

Getting Started

To run this project locally, you need to have Node.js (version 18) installed on your machine.

  1. Clone the repository:
git clone https://github.com/maccman/101-school.git
  1. Install dependencies:
pnpm install

  1. Set up your environment variables by copying the .env.example file to .env.local and filling in your details.

  2. Start the development server:

pnpm run dev

Environment Variables

Environment Variable Description
NEXT_PUBLIC_HANKO_API_URL The URL for the Hanko API, obtainable from your Hanko account dashboard.
DATABASE_URL Your PostgreSQL database connection string. We recommend Neon.
OPENAI_API_KEY The API key for OpenAI, available from the OpenAI API dashboard.
RESEND_API_KEY API key for the Resend service, available from the Resend service dashboard.
APP_HOST The hostname of your application, typically defined by your hosting service.
VERCEL_URL Automatically provided by Vercel when deploying, no action needed.
STRIPE_SECRET_KEY Your Stripe secret key, available from the Stripe dashboard.
STRIPE_PRICE_ID The price ID for your Stripe product, available from the Stripe dashboard.
STRIPE_WEBHOOK_SECRET The webhook secret for Stripe, available from the Stripe dashboard.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or find any bugs.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to OpenAI for providing the GPT-4 API.