/README.md-Template

A README template for my personal projects.

Project Name

e.g.

Project Name - Dev Blogs Front-End

Project Description

Your project Description here

e.g.

This project is a blog site web application that focuses on providing visitors with simple yet informative blog posts. The front-end design is minimalist and prioritizes simplicity and ease of use, allowing users to access and read blogs quickly and efficiently. The application was built using Vite, a fast and efficient build tool for modern web development, along with React, a popular JavaScript library for building user interfaces. The Tailwind CSS framework was also used to ensure a streamlined development process.

Note: Use image or gif as preview here.

You can view the live website here.

Note: Additional info goes here.

Main Objective/s

The goals/objectives/motivation of the project here.

e.g.

The main objectives of this project were to:

Document my learning journey and share knowledge with readers by providing informative and direct-to-the-point information. Through this blog site web application, I aim to help others learn new concepts and stay updated on relevant topics in a simple and efficient manner. Additionally, this project allows me to practice my development skills and expand my knowledge in web development.

Key Feature/s

Specific features of the project. Preferrably use a bullet points in here.

e.g.

The application name offers the following key features:

  • Add new blog posts: Users can create and publish new blog posts through a simple and intuitive interface.
  • Edit added blog posts: Users can make changes to existing blog posts, including updating the content, adding images, or modifying the formatting.
  • Delete blog posts: Users can delete blog posts that are no longer needed, removing them from the platform.
  • View blog posts through responsive design: The platform is designed to be responsive to different screen sizes, ensuring that users can access and read content on any device.
  • User authentication: Implement a user authentication system to ensure that only authorized users can perform actions such as creating, editing, and deleting blog posts.

What I've Learned

A short list of description on what you've learned in the process of making the project.

e.g.

Through this project, I gained the following knowledge and skills:

  • How to use React hooks such as useState, useEffect, useContext to manage state and side effects, respectively.
  • How to target specific media queries for responsive design in CSS.
  • How to use higher-order functions such as .map() and .filter() to dynamically generate components, improving code reusability and modularity.
  • How to use the React Router Dom library to enable client-side routing and create a seamless user experience.
  • How to store and authenticate cookies for user authentication and security in web development.
  • How to use Prettier and ESLint for code formatting and consistent code conventions on the project.

Overall, this project provided me with a solid foundation in modern web development using React and related technologies. The skills and knowledge I gained will be useful in future web development projects.

Quick Installation

A quick installtion guide for the project.

e.g.

  1. Clone the repository to your local machine:

    git clone https://github.com/your-user-name/your-repo-name.git

  2. Navigate to the project directory:

    cd your-repository

  3. Install the dependencies:

    npm install

  4. Start the development server:

    npm run dev

Open your web browser and navigate to http://localhost:5172 to view the website.

Contributing

Contributions are welcome! If you want to contribute to the project, please follow these guidelines:

  1. Fork the repository to your own GitHub account.

  2. Clone the repository to your local machine:

    git clone https://github.com/your-user-name/your-repo-name.git

  3. Create a new branch for your changes:

    git checkout -b your-branch-name

  4. Make your changes to the code.

  5. Commit your changes:

    git commit -m "Your commit message"

  6. Push your changes to your fork:

    git push origin your-branch-name

  7. Create a pull request from your fork to the main repository.

License

This project is licensed under the MIT License. See the LICENSE file for more information.