Giter Site home page Giter Site logo

post-editor's Introduction

Post Editor: A Web Application for Creating and Editing Posts

Post Editor is a web application that allows you to create and edit posts with rich text and images. You can use it to write blog posts, articles, tutorials, or any other type of content that you want to share online.

Post Editor is built with Next.js 14, Shadcn UI, Prisma, EditorJS, and a PostgreSQL database. It provides a user-friendly interface for creating, editing, and managing posts. It also integrates Cloudinary for seamless image upload, storage, and management.

![Post Editor screenshot]

Features

Post Editor has the following features:

  • Create and Edit Posts: You can easily create new posts and edit existing ones through a user-friendly interface.

  • Rich Text Editing: The application integrates EditorJS for a customizable and user-friendly rich text editing experience.

  • Image Upload with Cloudinary: You can utilize Cloudinary for seamless image upload, storage, and management in your posts.

  • Responsive Design: The user interface is designed to be responsive, providing a seamless experience across various devices.

  • Server-Side Rendering (SSR): The application uses Next.js 14 for server-side rendering, improving performance and SEO.

  • Shadcn UI Components: The application uses the UI components from Shadcn UI to enhance the overall aesthetics and usability of the application.

  • Prisma ORM: The application uses Prisma as an Object-Relational Mapping (ORM) tool to interact with the PostgreSQL database.

Tech Stack

Post Editor uses the following technologies:

Getting Started

To get started with Post Editor, you need to have the following prerequisites:

  • Node.js and npm installed on your machine
  • PostgreSQL database set up with appropriate credentials

Installation

To install Post Editor, follow these steps:

  1. Clone the repository:

    git clone https://github.com/avishka-devinda/post-editor.git
    cd post-editor
  2. Install dependencies:

    npm install
  3. Set up the PostgreSQL database and update the connection string in the .env file.

  4. Run the database migrations:

    npx prisma migrate dev
  5. Set up Cloudinary:

    • Sign up for a Cloudinary account.
    • Obtain your Cloudinary API key, API secret, and cloud name.
    • Update the .env file with your Cloudinary credentials.
  6. Start the development server:

    npm run dev
  7. Open your browser and navigate to http://localhost:3000 to view the application.

Image Upload with Cloudinary

To enable image upload with Cloudinary, ensure your .env file is configured with your Cloudinary credentials.

Create a .env.local File

Create a .env.local file in the root of your project and configure it similar to the provided .env.example file. Add your Cloudinary credentials and any other sensitive information.

Contributing

Contributions are welcome! Please follow the contribution guidelines.

License

This project is licensed under the MIT License.

I hope this helps you improve your document. If you have any questions or feedback, please let me know. ๐Ÿ˜Š

post-editor's People

Contributors

avishka-devinda avatar

Watchers

 avatar

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.