Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 6.43 KB

README.md

File metadata and controls

123 lines (93 loc) · 6.43 KB
Raw

ContentAI: Your AI-Powered Content Creation Engine

Unlock the power of AI to create engaging, high-quality content for your website, blog, social media, and more!

unreal

Introduction:

ContentAI is a revolutionary AI-powered content creation tool designed to streamline your workflow and empower you to produce compelling content with ease. Whether you're a seasoned writer or just starting out, ContentAI provides everything you need to create content that resonates with your audience.

Features:

  • Instant Content Generation: Generate high-quality text in seconds, saving you valuable time and effort.
  • Customizable Content: Tailor your output by adjusting tone, style, length, and other parameters to perfectly match your brand and voice.
  • Multiple Content Formats: Create a wide range of content types including blog posts, articles, social media posts, email copy, and more.
  • SEO Optimization: Boost your content's visibility and reach with built-in SEO optimization features.
  • Language Support: Generate content in multiple languages, expanding your reach to global audiences.

Benefits:

  • Increased Productivity: Generate content faster and more efficiently, freeing up your time for other important tasks.
  • Improved Quality: Create engaging and persuasive content that resonates with your audience and drives results.
  • Reduced Costs: Save money on content creation by leveraging the power of AI technology.
  • Enhanced Reach: Target new audiences and expand your market reach with multilingual capabilities.

Technology Stack:

ContentAI is built using a robust and modern technology stack to ensure performance, scalability, and security:

  • Frontend:
    • Next.js: A React framework for building fast and scalable web applications.
    • Tailwind CSS: A utility-first CSS framework for rapid UI development.
    • Material UI: A React UI component library for building beautiful and consistent interfaces.
    • Shadcn: A collection of reusable UI components and tools for Next.js projects.
    • Toast UI: A powerful JavaScript UI library providing components for rich text editing, grids, charts, and more.
    • Flaticon: A collection of high-quality icons for enhancing user interface design.
  • Backend:
    • Gemini API: A powerful AI model for generating high-quality text.
    • Clerk: An authentication and user management platform for web applications.
    • Drizzle-ORM: A type-safe and powerful database ORM for TypeScript.
    • Neon: A fast and reliable Postgres database for modern applications.
  • Other:
    • TypeScript: A strongly-typed superset of JavaScript for enhanced code maintainability.
    • Moment.js: A powerful JavaScript library for manipulating and formatting dates.

Getting Started:

  1. Sign up for a ContentAI account: Create your free account to start generating content.
  2. Choose a content format: Select the type of content you want to create, such as blog posts, articles, or social media captions.
  3. Customize your settings: Adjust the tone, style, and length to match your specific needs.
  4. Enter your desired topic or keywords: Provide the AI model with relevant information to generate accurate and engaging content.
  5. Generate your content instantly: ContentAI will generate your content in seconds, ready for you to review and publish.

Join the ContentAI Revolution:

Experience the future of content creation with ContentAI. Start writing engaging and high-quality content with ease today!

Links:

Contributing:

We welcome contributions to ContentAI! Please review our contribution guidelines before submitting a pull request.

Contribution Guidelines

Thank you for considering contributing to our AI-powered content creation project! Please follow these guidelines to ensure smooth collaboration:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-name/ContentAI.git
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  4. Make your changes and ensure they adhere to the project's coding style and guidelines.
  5. Test your changes thoroughly to avoid introducing bugs.
  6. Commit your changes with clear and descriptive commit messages: 
    git commit -m 'Add your descriptive commit message'
  7. Push your changes to your forked repository: 
    git push origin feature/your-feature-name
  8. Open a pull request against the main branch of the original repository.
  9. Provide a clear and concise description of your changes in the pull request, along with any relevant information.
  10. Ensure your pull request passes all checks and tests before requesting a review.

Setting Up Environment Variables

To run ContentAI locally, you need to set up the following environment variables:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=YOUR_CLERK_PUBLISHABLE_KEY
CLERK_SECRET_KEY=YOUR_CLERK_SECRET_KEY
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_GOOGLE_GEMINI_API_KEY=YOUR_GOOGLE_GEMINI_API_KEY
NEXT_PUBLIC_DRIZZLE_DB_URL=YOUR_DRIZZLE_DB_URL

Instructions for Obtaining API Keys:

  • Clerk API Keys:
    • Sign up for a free Clerk account at https://clerk.dev/.
    • Obtain your Publishable Key and Secret Key from your Clerk dashboard.
  • Google Gemini API Key:
    • Sign up for a Google Cloud Platform account at https://cloud.google.com/.
    • Enable the Gemini API and create a project.
    • Obtain your API key from the Google Cloud Platform console.
  • Drizzle-ORM DB URL:
    • Configure your local Postgres database.
    • Replace YOUR_DRIZZLE_DB_URL with the connection string for your database.

Once you have obtained all the necessary API keys, replace the placeholders in the environment variables above and proceed with the development setup.

Let ContentAI be your partner in creating compelling content that engages your audience and drives your success.