Giter VIP home page Giter VIP logo

doped-caul's Introduction

๐Ÿ–‹๏ธ Doped-Caul ๐Ÿ–‹๏ธ

Markdown โ†’ AI โ†’ Publish


Note

"Doped-Caul" is a cutting-edge platform that combines the expertise of human writers with the capabilities of artificial intelligence. It allows technical writers to create and publish their articles efficiently, with the help of an AI assistant that can automatically enhance and complete your work. The platform boasts a user-friendly interface, a safe and secure environment with GitHub OAuth login, and a streamlined publishing process, eliminating the hassle of managing multiple platforms.


dev.to
๐Ÿ’€ React on my dev.to article written on this project or no cookie! ๐Ÿ’€


โœจ Features

  • AI-Powered Writing Assistant ๐Ÿง : Leverage the power of AI to enhance and streamline your writing process. Get real-time suggestions and assistance from advanced language models.

  • Seamless Integration with Popular Platforms ๐ŸŒ: Publish your AI-written articles directly to platforms like dev.to, Medium, and Hashnode with just a few clicks. No more hassle of managing multiple platforms.

  • Secure and User-Friendly Interface ๐Ÿ”’๐Ÿ’ป: Enjoy a safe and secure environment with GitHub OAuth login. The intuitive UI ensures a smooth writing experience for technical writers.

  • Customizable Prompts ๐ŸŽจ: Tailor the AI prompts to your specific needs, ensuring that the generated content aligns with your writing style and preferences.

  • Markdown Support ๐Ÿ“: Write in Markdown format and get a live preview of your content rendered in HTML, making it easy to visualize the final output.

  • Responsive Design ๐Ÿ“ฑ๐Ÿ’ป: Access and write from anywhere, with a mobile-friendly interface that adapts to various screen sizes.

  • Robust Backend ๐Ÿ› ๏ธ: Built with Express.js and powered by OpenAI's GPT-3.5 model, ensuring reliable and high-quality AI-generated content.

๐Ÿ’ป Tech Stack

Frontend:

  • React
  • Refine (React-based framework)
  • UnoCSS (Utility-first CSS framework)
  • CopilotKit (AI integration)

Backend:

  • Node.js
  • Express.js
  • OpenAI API (GPT-3.5 model)

Authentication and Database:

  • Supabase (Authentication and Database solution)

Other Libraries and Tools:

  • marked (Markdown to HTML converter)
  • React Memo (Performance optimization)
  • GitHub OAuth (Secure authentication)

๐Ÿ“ท Screenshots

Here's a working and expected screenshot of dope caul

Landing Page
Demo
Dashboard
Demo
New Post
Demo
Edit Post
Demo
Publish Post
Demo
Markdown Editor
Demo
Supabase posts table fields
Demo

๐Ÿš€ Configure these things

โš™๏ธ Environment Variables and Configuration โš’๏ธ

To run the project locally, you'll need to set up the following environment variables: ๐Ÿ”‘

VITE_SECRET="<your secret word(s) to encode secret data>" ๐Ÿ”’
VITE_SUPABASE_URL="<your supabase project url>" ๐ŸŒ
VITE_SUPABASE_KEY="<your supabase project key>" ๐Ÿ”‘
OPENAI_KEY="<your openai api key>" ๐Ÿค–

Additionally, you'll need to configure the frontend and backend URLs: ๐ŸŒ

Frontend: ๐Ÿ’ป

In the root directory of your project, locate the main.jsx file (or the entry point of your React application). Inside this file, you'll find the CopilotKit component. Update the url and runtimeUrl props with your backend URL: ๐Ÿ”—

<CopilotKit
  url="<your backend url>" ๐Ÿ”—
  runtimeUrl="<your backend url>" ๐Ÿ”—
>
  {/* ... */}
</CopilotKit>

Backend: ๐Ÿ–ฅ๏ธ

In your backend code (e.g., Express.js server), you'll need to set up CORS (Cross-Origin Resource Sharing) to allow requests from your frontend origin. Update the Access-Control-Allow-Origin header with your frontend URL: ๐ŸŒ

app.use(function (req, res, next) {
  res.header("Access-Control-Allow-Origin", "<your frontend url>"); ๐ŸŒ
  res.header(
    "Access-Control-Allow-Headers",
    "Origin, X-Requested-With, Content-Type, Accept"
  );
  next();
});

Make sure to replace <your frontend url> and <your backend url> with the appropriate URLs for your local development environment. ๐Ÿš€

Tip

By setting up the environment variables and configuring the frontend and backend URLs, you'll ensure that the application can communicate with the necessary services and APIs correctly.


๐Ÿค Contribution

We welcome contributions to Tila Dashboard! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature / bug fix.
  3. Make your changes & commit them.
  4. Push your changes to your forked github repository.
  5. Submit a PR to this GitHub repository.

๐Ÿ’ซ If you find this project interesting, please consider giving it a on GitHub to show your support! ๐Ÿ’ซ

doped-caul's People

Contributors

arnavk-09 avatar

Watchers

 avatar

doped-caul's Issues

Logo

<svg viewBox="0 0 36 36" fill="none" role="img" xmlns="http://www.w3.org/2000/svg" width="80" height="80"><mask id=":r37:" maskUnits="userSpaceOnUse" x="0" y="0" width="36" height="36"><rect width="36" height="36" rx="72" fill="#FFFFFF"></rect></mask><g mask="url(#:r37:)"><rect width="36" height="36" fill="#dd1d38"></rect><rect x="0" y="0" width="36" height="36" transform="translate(-2 6) rotate(306 18 18) scale(1)" fill="#00e1db" rx="36"></rect><g transform="translate(-2 6) rotate(6 18 18)"><path d="M13,19 a1,0.75 0 0,0 10,0" fill="#000000"></path><rect x="13" y="14" width="1.5" height="2" rx="1" stroke="none" fill="#000000"></rect><rect x="21" y="14" width="1.5" height="2" rx="1" stroke="none" fill="#000000"></rect></g></g></svg>

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.