Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syedahmedullah14/blogging-app-like-medium

A Medium-like blogging application built from scratch using React with Vite, Cloudflare Workers, TypeScript, Prisma, and PostgreSQL. Features include user authentication with JWT, skeleton loading for improved UX, and connection pooling with Prisma. Deployed on Vercel and Cloudflare Workers.
https://github.com/syedahmedullah14/blogging-app-like-medium

cloudflare hono javascript jwt-authentication nodejs postgresql prisma-accelerate prisma-client prisma-orm reactjs skeleton-css tailwindcss typescript vitejs zod-validation

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/syedahmedullah14/blogging-app-like-medium
Owner: syedahmedullah14
Created: 2024-06-20T07:38:28.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-06-25T15:36:06.000Z (7 months ago)
Last Synced: 2024-11-17T12:40:00.873Z (3 months ago)
Topics: cloudflare, hono, javascript, jwt-authentication, nodejs, postgresql, prisma-accelerate, prisma-client, prisma-orm, reactjs, skeleton-css, tailwindcss, typescript, vitejs, zod-validation
Language: TypeScript
Homepage: https://blogging-app-like-medium.vercel.app
Size: 567 KB
Stars: 13
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Blogging App Like Medium

This is a blogging application inspired by Medium, developed as part of Cohort 2.0 by Harkirat. The project is built from scratch using a modern tech stack and deployed on Vercel and Cloudflare Workers.

## Live Demo
Check out the live app [here](https://blogging-app-like-medium.vercel.app/).
## Features

- User Authentication (JWT)
- Skeleton Loading for a smoother user experience
- Connection Pooling with Prisma
- Type Inference and Validation with Zod

## Tech Stack

### Frontend

- **React**: A JavaScript library for building user interfaces.
- **Vite**: A build tool that significantly improves the development experience.
- **Skeleton Loading**: For enhanced UX during data fetches.

### Backend

- **Cloudflare Workers**: Serverless functions for handling backend logic.
- **TypeScript**: A strongly typed programming language that builds on JavaScript.
- **Prisma**: ORM for database interaction with connection pooling.
- **PostgreSQL**: The relational database used.
- **Zod**: For schema validation and type inference.
- **JWT**: For secure authentication.

## Getting Started

Follow these instructions to set up the project locally.

### Prerequisites

- Node.js
- PostgreSQL

### Installation

1. Clone the repository:

git clone https://github.com/syedahmedullah14/blogging-app-like-medium.git

2. Navigate to the project directory:

cd blogging-app-like-medium

3. Install the dependencies:

npm install

### Configuration

1. Set up your environment variables. Create a `.env` file in the root directory and add the following:

DATABASE_URL=your_postgres_connection_string
JWT_SECRET=your_jwt_secret

2. Configure Cloudflare Workers and Vercel for deployment (refer to their respective documentation for detailed steps).

### Running the Application

1. Start the backend (Cloudflare Workers) and frontend (Vercel):

#For the backend
npm run start:backend

#For the frontend
npm run dev

2. Open http://localhost:3000 to view the application in your browser.

## Deployment

### Backend

Deploy the backend using Cloudflare Workers. Follow the Cloudflare Workers documentation for detailed deployment instructions.

### Frontend

Deploy the frontend on Vercel. Follow the Vercel documentation for detailed deployment instructions.

## Contributing

Contributions are welcome! Please fork the repository and submit a pull request.