Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mounishvatti/blogscafe
A blogging website where users can login, create blogs and post them
https://github.com/mounishvatti/blogscafe
appwrite react-hook-form react-html-parser react-redux react-router-dom reactjs redux tailwindcss tinymce vite
Last synced: about 24 hours ago
JSON representation
A blogging website where users can login, create blogs and post them
- Host: GitHub
- URL: https://github.com/mounishvatti/blogscafe
- Owner: mounishvatti
- Created: 2024-08-17T07:22:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-19T14:12:28.000Z (4 months ago)
- Last Synced: 2024-11-10T03:13:11.473Z (about 1 month ago)
- Topics: appwrite, react-hook-form, react-html-parser, react-redux, react-router-dom, reactjs, redux, tailwindcss, tinymce, vite
- Language: JavaScript
- Homepage: https://blogscafe.vercel.app
- Size: 91.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BlogsCafe - "Your Personal Blogging Hub"
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Folder Structure](#folder-structure)
- [Contributing](#contributing)
## Introduction
**Blogscafe** is a full-stack web application that provides users with a platform to create, edit, and share blogs. Whether you're a seasoned blogger or just getting started, Blogscafe is designed to make your blogging experience seamless and enjoyable. The platform allows users to explore blogs created by others, fostering a vibrant community of writers and readers.
## Features
- **User Authentication:** Secure login and registration with Appwrite.
- **Blog Creation & Management:** Create, edit, and delete your blogs effortlessly.
- **Community Interaction:** Browse and read blogs created by other users.
- **Responsive Design:** Fully responsive UI/UX built with Tailwind CSS.
- **Scalable Backend:** Appwrite as Backend-as-a-Service for authentication, database, and storage.
- **Deployment:** Deployed on Vercel for fast and reliable performance.
## Tech Stack
- **Frontend:** React, Tailwind CSS
- **Backend:** Appwrite (Backend-as-a-Service)
- **Deployment:** Vercel
- **Dependencies:** TinyMCE for editor, React-Hook-Form, HTML-React-Parser
## Installation
To run this project locally, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/mounishvatti/blogscafe.git
cd blogscafe
```
2. **Install dependencies:**
```bash
npm install
```
3. **Configure Appwrite:**
- Set up an Appwrite project.
- Create collections for users and blogs.
- Set up authentication and permissions.
- Configure your `.env` file with Appwrite project details.
4. **Start the development server:**
```bash
npm run dev
```
5. **Build for production:**
```bash
npm run build
```
6. **Deploy to Vercel:**
- Ensure that your build output is optimized for Vercel deployment.
- Connect the repository to Vercel and deploy.
## Usage
1. **Sign Up:** Create an account using the signup page.
2. **Login:** Access your account to start creating blogs.
3. **Create/Edit Blogs:** Use the editor to write and manage your blog posts.
4. **View Blogs:** Browse through the collection of blogs created by others.
5. **Responsive Experience:** Enjoy a seamless experience across devices.
## Folder Structure
```
blogscafe/
│
├── public/ # Static assets and public files
├── src/
│ ├── appwrite/ # Authentication and database configuration
│ ├── components/ # Reusable components
│ ├── pages/ # Application pages (Home, Login, Signup, etc.)
│ ├── store/ # Redux store configuration
│ ├── App.jsx # Main application component
│ ├── index.css # Global styles
│ ├── index.js # Entry point
│ └── ...
├── .env # Environment variables
├── package.json # Dependencies and scripts
├── README.md # Project documentation
└── ...
```
## Contributing
Contributions are welcome! If you'd like to contribute to Blogscafe, please fork the repository, create a new branch, and submit a pull request. Before contributing, ensure that your code adheres to the project's coding standards and is thoroughly tested.