/ai-content-generator

Primary LanguageTypeScriptMIT LicenseMIT

GitHub issues GitHub pull requests GitHub forks GitHub Repo stars GitHub contributors
Repo Size PRs Welcome
Visitors Count

Project Structure ✨

Check the project structure here Project Structure

Table of Contents

  1. Introduction
  2. Tech Stack
  3. Features
  4. Installation Guide
  5. Contributing Guide
  6. Outreach
  7. Project Admin
  8. Code of Conduct
  9. Learn More
  10. Deploy on Vercel
  11. License
  12. Support
  13. Contributors

✨🎈Introduction

AI Content Generator is a web-based application built using Next.js and TypeScript. It is designed to create AI-driven content generation tools with modern development frameworks. The project aims to provide efficient and scalable content workflows to improve productivity, and it is deployable via Vercel for quick and easy hosting.

⌨️Tech Stack

  • React: A JavaScript library for building user interfaces.
  • Next.js: A React framework for server-side rendering and static site generation.
  • Gemini: (Add a short description of its use in your project).
  • Clerk: Authentication and user management made simple.
  • TailwindCSS: A utility-first CSS framework for rapid UI development.
  • TypeScript: A typed superset of JavaScript that adds static typing.

💻Features

  • AI-driven content generation.

  • Scalable and efficient automated content workflows.

  • Server-side rendering and static site generation using Next.js.

  • Integrated user management and authentication via Clerk.

  • Stylish, responsive design using TailwindCSS.

  • Easy deployment through Vercel.

    🧑🏻‍💻Installation Guide

  1. Clone this repository to your local machine:

    git clone https://github.com/your-username/ai-content-generator.git
    cd ai-content-generator
    
  2. Install the required dependencies:

    npm install 
    
  3. Setup environment variables Create a .env.local file in the root directory and add the following values:

    SOCKET_IO_SERVER_URL=http://localhost:3001
    
  4. Run the application For development:

npm run dev

For production:

npm run build
npm start

📦 Settingup NeonDB and Clerk

  1. Go to Neon and sign up for a new account or log in if you already have one.

Step 2: Create a Database

  1. In your Neon dashboard, click on Create Database.
  2. Enter a name for your database and select your preferred region.
  3. Click on Create to provision your new database.
  4. Choose next.js and go to tab .env just below and copy the 'DATABASE_URL'
  5. Update your .env.local file to include the connection string:

Creating Clerk

  1. Create application in Clerk
  2. Choose next.js
  3. In second step copy all the content of .env.local from clerk platform
  4. Paste it in .env.local in your local machine

.env.local

  1. NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="your NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY"

  2. CLERK_SECRET_KEY="your-CLERK_SECRET_KEY"

  3. NEXT_PUBLIC_DATABASE_URL = "neonDB datbase url"

🛠️ Contributing Guide

We welcome contributions to the videocall webapp project! To contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature-name)
  3. Commit your changes (git commit -am 'Add new feature')
  4. Push to the branch (git push origin feature-name)
  5. Create a new Pull Request

Please refer to the CONTRIBUTING.md for more detailed information.

💪 Outreach

HelpOps-Hub is proudly part of global initiatives engaging with passionate developers and open-source enthusiasts worldwide:

Name Logo Purpose
GSSoC'2024-Extd a white background with the text, GirlScript Summer of Code next to an orange flower The coding period is from October 1st to October 30th, during which contributors make contributions and earn points on the platform.
Hacktoberfest 2024 a black background with the official logo of Hacktoberfest 2024 Hacktoberfest is a month-long October event welcoming all skill levels to join the open source community, contribute quality pull requests on GitHub, and earn cool swag.

Project Admin

man-techno

Kanhaiyakr01

https://https://www.linkedin.com/in/kanhaiyakumar01/

📑Code Of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

📚 Learn More

To deepen your understanding of Next.js, check out these valuable resources:

🌐 Deploy on Vercel

The simplest way to deploy your Next.js app is through the Vercel Platform, created by the team behind Next.js. For more deployment options, refer to our Next.js deployment documentation.

📝License


Gityzer is licensed under the terms of the MIT License. check out LICENSE for details.

⭐Support

  • 💰 Become our Sponsor!

  • ⭐ Star our Repo

    Contributors

    🫱🏼‍🫲🏼Big thanks to all the contributors! 🫱🏼‍🫲🏼

(Back to top⬆️)