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.
- Users can create accounts by providing email, username, and password.
- Existing users can log in securely.
- 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.
- Users have the ability to delete and edit their blog posts at any time.
- Users can also update their profile through the profile page.
- Write blog content using Markdown format for a rich text experience, which will be displayed accordingly.
- 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.
To run the application locally, follow these steps:
- Download the ZIP file and extract it.
- Navigate to both the
client
folder andserver
folder in the terminal and run the following command in both of them to install packages.npm i
- Navigate to the root folder and run:
This will install the necessary packages, including
npm i
concurrently
, which is needed to run both frontend and backend simultaneously. - In the root folder, run:
This will concurrently run both the frontend and backend.
npm start
- Frontend is hosted on http://localhost:5000
- Backend is hosted on http://localhost:3000
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.