Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 1.93 KB

README.md

File metadata and controls

85 lines (60 loc) · 1.93 KB

Scribe Blog Platform

Scribe Space is a clone of the popular Medium app, built with modern web technologies for a seamless blogging experience.

Live Demo

Check out the live version: Scribe Space

Features

  • Backend: Cloudflare Workers, Hono, PostgreSQL, Prisma
  • Frontend: ReactJS, Tailwind-CSS
  • Deployment: Vercel

Table of Contents

Installation

Backend

  1. Clone the repository:

    git clone https://github.com/chiraggowda92187/Scribe.git
cd Scribe/backend

  2. Set up environment variables: Create a .env file in the backend directory and add your PostgreSQL credentials.

    Example .env file:

    DATABASE_URL=postgresql://username:password@localhost:5432/database

  3. Run the development server:

    npm run dev

Frontend

  1. Navigate to the frontend directory:

    cd ../frontend

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env file in the frontend directory if needed.

  4. Run the development server:

    npm run dev

Usage

Once both the backend and frontend servers are running, you can access the application in your web browser at http://localhost:3000.

API Endpoints

  • Get all posts: GET /api/posts
  • Get a single post: GET /api/posts/:id
  • Create a post: POST /api/posts
  • Update a post: PUT /api/posts/:id
  • Delete a post: DELETE /api/posts/:id

Frontend Pages

  • Home: Displays a list of all posts.
  • Post Detail: Displays a single post.
  • Create/Edit Post: Form to create or edit a post.

Contributing

Contributions are welcome! Please fork this repository and submit pull requests.