Skip to content

A blog application built using React, TypeScript, and the Shadcn/UI component library. Features a WYSIWYG editor, search functionality, and lazy-loaded images for a smooth user experience.

Notifications You must be signed in to change notification settings

KozerT/Blog-app

Repository files navigation

Blog App

A simple blog application built with React, TypeScript, and Shadcn/UI. This project was bootstrapped with Create React App.

Deployment

This project is deployed on Vercel. Check it out live here!

Features

  • View a list of blog posts with pagination and search functionality.
  • Create new blog posts with a WYSIWYG editor.
  • Edit and delete existing blog posts.
  • View individual blog posts with details and images.

Technologies Used

  • React: The core JavaScript library for building user interfaces.
  • TypeScript: Provides static typing for improved code quality and maintainability.
  • Shadcn/UI: A collection of accessible and customizable UI components.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • React Router: Handles navigation and routing within the app.
  • React Hook Form: Simplifies form management and validation.
  • Zod: Provides schema validation for form data.
  • react-simple-wysiwyg: A basic WYSIWYG editor for rich text editing.
  • react-lazyload: Optimizes image loading by lazy loading images.
  • date-fns: Provides convenient functions for working with dates.
  • Lucide React: An icon library for React applications.
  • ESLint: A static code analysis tool for identifying problematic patterns found in JavaScript code.

Implementation Notes

  • State Management: The application uses React's Context API for global state management (BlogContext).
  • Data Storage: Blog posts are stored in the browser's local storage.
  • Form Validation: react-hook-form and zod are used for form validation and schema definition.
  • WYSIWYG Editor: The react-simple-wysiwyg library provides a basic WYSIWYG editor for creating and editing blog post content.
  • Lazy Loading: react-lazyload is used to lazily load images, improving performance.

Getting Started with the project

  1. Clone the repository:

    git clone [URL]
  2. Navigate to the project directory:

    cd blog-app
  3. Install dependencies:

    npm install
    # or
    yarn install
  4. Start the development server:

    npm start
    # or
    yarn start  
    

    The app should now be running at http://localhost:3000 in your browser.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run lint

ESLint is configured to ensure code quality and consistency. Analyze the code for potential errors and style violations.

npm run lint:fix

Automatically fix any fixable linting issues.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Screenshots

  • Blog Post List Page
Screenshot 2024-08-10 at 11 39 12 2
  • Blog Post Detail Page
Screenshot 2024-08-10 at 11 41 00
  • New/Edit Blog Post Page
Screenshot 2024-08-10 at 11 40 15
  • Delete Confirmation Modal
Screenshot 2024-08-10 at 11 41 16

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

A blog application built using React, TypeScript, and the Shadcn/UI component library. Features a WYSIWYG editor, search functionality, and lazy-loaded images for a smooth user experience.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published