Giter Club home page Giter Club logo

reactjs-blogging-app's Introduction

Hyrule Gazette

Welcome to Hyrule Gazette, a blog application inspired by the legendary world of Zelda! This README provides an overview of the features and instructions on how to run the application locally.

Table of Contents

  1. Features
  2. Running Locally
  3. API Documentation

Features

Login and Signup

  • Users can create accounts by providing email, username, and password.
  • Existing users can log in securely. Login_Signup_Forms

Create Blogs with special "Generate Content" feature

  • Craft your blogs with your own header image, title, content and blurb.
  • Utilize the special "Generate Content" feature for Zelda-themed inspiration. (Credits to open-source Zelda API https://docs.zelda.fanapis.com/ ).
  • Provides a sample image, title, and content generated about Zelda games, dungeons, bosses, and locations. AddingPost

Delete and Edit Blogs

  • Users have the ability to delete and edit their blog posts at any time.
  • Users can also update their profile through the profile page. Profile

Markdown Format Support

  • Write blog content using Markdown format for a rich text experience, which will be displayed accordingly. DisplayBlog

Rate, Comment, and Follow

  • Users can rate blog posts, leave comments, and follow their favorite bloggers. RateCommentFollow

View Notifications and User Feed

  • Stay updated with notifications and view a personalized user feed based on who you are following. Notifs

Search, Filter, and Pagination

  • Easily search for specific blog posts by keywords or authors.
  • Filter posts based on categories or keywords.
  • Navigate through paginated blog posts for a seamless experience.
  • Control number of blogs displayed per page. SearchFilter

Running Locally

To run the application locally, follow these steps:

  1. Download the ZIP file and extract it.
  2. Navigate to both the client folder and server folder in the terminal and run the following command in both of them to install packages.
    npm i
  3. Navigate to the root folder and run:
    npm i
    This will install the necessary packages, including concurrently, which is needed to run both frontend and backend simultaneously.
  4. In the root folder, run:
    npm start
    This will concurrently run both the frontend and backend.

API Documentation

Explore the backend API documentation here for details on the API endpoints, the required parameters and headers for each, and the expected response statuses.

Whether you're a seasoned adventurer or an age-old enthusiast, Hyrule Gazette has everything you need to dive into the world of Zelda games.

reactjs-blogging-app's People

Contributors

haadiyeah avatar github-classroom[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.