Giter Club home page Giter Club logo

howto's Introduction

YelpCamp logo

HowTo

Create, Share and Connect with your unique how-to ideas

📜 Table of Contents

Click me

💡 Overview

HowTo is a place to discover and craft unique step-by-step tutorials, from DIY projects to everyday challenges. While the guides may not claim to be the world's most practical, they are guaranteed to spark smiles and foster creativity!

🧩 Built with

built with vitest logo testing library logo

✨ Features

Drag and drop to re-order the steps

Bookmark your favorite how-to creations

Leave a comment to share your thoughts

Search for all kinds of how-to ideas

Personalize your profile with custom bio and images

Manage your username, email and password easily

🤔 Future Features

  • Use existed how-to tutorials as starting template
  • Save creation to drafts, edit and publish later
  • Get notifications when following users post a new tutorial
  • Develop backend code to separate data logic from the UI logic

🚀 Run Locally

  1. Clone this project to your local environment
$ git clone "https://github.com/KellyCHI22/HowTo.git"
  1. Open the project and type the following command in your terminal
$ npm install
  1. Continue with this command after finishing installing all the packages
$ npm run dev
  1. Open your browser and navigate to the following path: http://localhost:5173/

  2. Account for testing:

email:[email protected]
password:cool123
  1. Type the following command to stop the dev server
ctrl + c

💻 Tech Stack

Core Technologies

  • TypeScript 5.0.2
  • React 18 (Hooks) 18.2.0
  • React Router 6.11.1
  • React Redux 8.0.5
  • Redux toolkit / Redux toolkit query 1.9.5
  • Tailwind CSS 3.3.2

Firebase v9.21.0

  • Authentication
  • Firestore
  • Storage
  • Hosting

Packages

  • react-beautiful-dnd 13.1.1
  • react-firebase-hooks 5.1.1
  • react-paginate 8.2.0
  • react-responsive 9.0.2
  • react-icons 4.8.0
  • react-spinners 0.13.8
  • javascript-time-ago 2.5.9
  • react-time-ago 7.2.1
  • clsx 1.2.1
  • browser-image-compression 2.0.2

Development Tools

  • Vite 4.3.2
  • Eslint 8.38.0
  • Prettier 2.8.8
  • Vitest 0.32.2
  • @testing-library/jest-dom 5.16.5
  • @testing-library/react 14.0.0
  • @testing-library/user-event 14.4.3

📦 File Structure

-- public
-- src
  |__ App.tsx
  |__ assets
  |__ components
    |__ elements
    |__ layouts
  |__ hooks
  |__ pages
  |__ store
    |__ apis
  |__ utils

🤯 Development Process

Design file

User flow

Functional map

🔒 License

Copyright Notice and Statement: currently not offering any license. Permission only to view and download.

howto's People

Contributors

kellychi22 avatar

Stargazers

 avatar  avatar Tiny_Murky avatar Tommy Chi avatar Wei Kai, Lin avatar Lois Chen avatar

Watchers

 avatar

howto's Issues

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.