Syllabuilder.online is a web application designed to generate personalized courses for users. It integrates with Next.js, NextAuth, Prisma, PlanateScale (MySQL), and utilizes the OpenAI API for course generation.
- User Authentication: Secure authentication and authorization using NextAuth.
- Database Management: Prisma with MySQL for efficient data storage.
- OpenAI API Integration: Generates personalized courses based on user input.
- Next.js Optimization: Utilizes server-side rendering and client-side rendering for enhanced performance.
- CI/CD with GitHub Actions: Implements continuous integration and deployment.
- User-Friendly Interface: Provides an intuitive input form for course generation.
-
Clone the repository:
git clone https://github.com/SOUMOJIT-CHAKRABORTY/syllabuilder.online.git cd syllabuilder.online -
Install dependencies:
npm install
-
NextAuth: Follow the NextAuth documentation to set up authentication providers.
-
Prisma: Set up your database connection in the
schema.prismafile. Replace the connection URL with your MySQL database. -
OpenAI API: Obtain API credentials from OpenAI and set them in your environment variables.
NEXT_PUBLIC_OPENAI_API_KEY=your_openai_api_key
-
Start the development server:
npm run dev
The application will be accessible at http://localhost:3000.
-
Visit the website and use the input form to generate personalized courses.
-
Install Docker and Docker Compose if you haven't already.
-
Build and run the Docker containers:
docker-compose up --build
This command will build the Docker images and start the containers.
Once the containers are running, you can access the application at http://localhost:3000.
-
Deploy the application to DigitalOcean or your preferred hosting provider.
-
Set the production environment variables, including database connection and OpenAI API key.
-
Configure GitHub Actions for automated CI/CD by updating the workflow file in the
.github/workflowsdirectory.