Skip to content

FreemanBoss/handyman-frontend

Repository files navigation

Handyman is a web, later a mobile application, designed to connect users with local craftsmen for various household chores. Users can book electricians, plumbers, and other craftsmen to assist with their home maintenance needs. The app aims to provide a seamless and efficient way to get reliable help for everyday tasks.

Project Startup Guide

Welcome to the project! This README provides a comprehensive guide to get you started with the project setup, including how to run the application locally, manage dependencies, and perform common tasks.

Table of Contents

  1. Prerequisites
  2. Setup
  3. Running the Project

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v14.x or later)
  • npm (comes with Node.js) or Yarn (optional, but recommended)

Setup

  1. Clone the Repository

    git clone https://github.com/FreemanBoss/handyman-frontend
    cd handyman-frontend
    
  2. Install Dependencies

Make sure you have all necessary dependencies installed.

  • Using npm:

npm install

Running the Project

    • To run the project on the development server

npm run dev
    • To run the project on the staging server

npm run staging
    • To run the project on the production server

npm run prod

Contributing

We welcome contributions to the project! Please refer to our CONTRIBUTING.md file for guidelines on how to contribute.

License

By contributing, you agree that your contributions will be licensed under the Apache License.

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •