Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

68 lines (46 loc) · 2.16 KB

WordWave

LIVE DEMO

Table of Contents

  1. Introduction
  2. Features
  3. Tech Stack
  4. Getting Started
  5. Contributing
  6. License

Introduction

WordWave is a blogging website designed to provide a seamless experience for writers and readers alike. It leverages a serverless backend powered by PostgreSQL and Prisma, deployed on Cloudflare Workers, and a frontend built with React, Vite, and Tailwind CSS, deployed on GitHub Pages.

Features

  • User Authentication: Secure login and registration system.
  • Content Management: Intuitive interface for writing, editing, and publishing blog posts.
  • Responsive Design: Optimized for various devices, ensuring a consistent experience.

Tech Stack

  • Backend: PostgreSQL, Prisma, Serverless (Cloudflare Workers)
  • Frontend: React, Vite, Tailwind CSS
  • Deployment: GitHub Pages (Frontend), Cloudflare Workers (Backend)

Getting Started

To get a local copy of the project up and running, follow these steps:

Backend Setup

  1. Clone the repository.
  2. Navigate to the backend directory.
  3. Install dependencies using npm install.
  4. Set up your PostgreSQL database and configure Prisma.
  5. Deploy the backend to Cloudflare Workers.

Frontend Setup

  1. Navigate to the frontend directory.
  2. Install dependencies using npm install.
  3. Configure environment variables.
  4. Build the frontend using Vite (npm run build).
  5. Deploy the frontend to GitHub Pages.

Contributing

Contributions are welcome! To contribute to WordWave, follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License.

Feel free to adjust any details or add specific instructions as needed for your WordWave project.