https://github.com/xonoxc/globo
A blog application for creating , sharing and writing blogs
https://github.com/xonoxc/globo
eslint git reactjs redux tailwindcss typescript
Last synced: 3 months ago
JSON representation
A blog application for creating , sharing and writing blogs
- Host: GitHub
- URL: https://github.com/xonoxc/globo
- Owner: xonoxc
- Created: 2024-03-04T07:03:08.000Z (over 2 years ago)
- Default Branch: dedicated_backend
- Last Pushed: 2024-11-09T12:40:21.000Z (over 1 year ago)
- Last Synced: 2025-04-04T14:44:49.817Z (over 1 year ago)
- Topics: eslint, git, reactjs, redux, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://globo-ecru.vercel.app
- Size: 931 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Globo Blog
Globo Blog is a modern blogging platform built with Vite and React. This application allows users to create, edit, view, and manage blog posts with an intuitive, high-performance UI.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Features
- Create, edit, and delete blog posts
- Rich text editor support
- Responsive and optimized for performance
- User authentication and authorization
- SEO-friendly
- Dynamic routing for blog posts
- Commenting functionality with replies
- State management using Zustand
## Tech Stack
- **Frontend:** React, Vite, Redux for state management
- **Styling:** CSS Modules / Styled Components (optional)
- **Backend :** Node.js + Typescript
- **Authentication:** : Custom JWT authentication
- **Caching** : Redis
## Getting Started
### Prerequisites
- Node.js (>= 14.x.x) and npm (>= 6.x.x) or yarn (>= 1.22.x)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/xonoxc/Globo.git
cd Globo
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Create a .env file and add environment variables as stated in .env.sample file
### Running the application
1. To start the development server:
```bash
npm install
#or
yarn install
```
Open [http://localhost:5173](http://localhost:5173) to view the app in the browser
## Production Build
1. To build the project for production, run:
```bash
npm run build
# or
yarn build
```
## Project Structure
> [!NOTE]
> this is general overview of the project structure files may change as development progresses
```bash
├── public # Static assets
├── src
│ ├── assets # Image and other assets
│ ├── components # Reusable components
│ ├── pages # Page components (Home, Blog, etc.)
│ ├── hooks # Custom hooks
│ ├── store # Redux store
│ ├── utils # Utility functions
│ └── App.jsx # Main App component
├── .env # Environment variables
└── vite.config.js # Vite configuration
```
## Api repository
See [backend](https://github.com/xonoxc/Globo_backend.git) for the backend and api portion
# Contributing
Contributions are welcomed! Please submit a pull request or open an issue for feature requests and bug fixes.
# License
This project is licensed under the MIT license.