Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 2.7 KB

README.md

File metadata and controls

91 lines (59 loc) · 2.7 KB
Raw

Emergency Financial Hotspot for Cashless Transactions

Overview

This project aims to create a decentralized peer-to-peer cashless transaction system that works offline, designed for emergency situations or areas with limited internet connectivity.

Getting Started

Follow these instructions to set up and run the project in GitHub Codespaces.

Prerequisites

  • A GitHub account
  • Access to GitHub Codespaces (available in GitHub Teams and GitHub Enterprise Cloud plans)

Running the Project

  1. Open the Repository: Go to the Emergency Financial Hotspot repository.

  2. Create a Codespace:

    • Click on the green Code button.
    • Select Open with Codespaces and then click on New codespace.

  3. Install Dependencies: Once the Codespace is set up, open the terminal and run the following command to install the necessary dependencies:

    npm install

For run into Local machine---

Getting Started

Follow these instructions to set up and run the project on your local machine.

Prerequisites

Before you begin, ensure you have the following software installed:

  • Node.js (version 18 or higher) and npm (Node Package Manager). You can download it from nodejs.org.
  • Git for version control. You can download it from git-scm.com.

Installation

  1. Clone the Repository: Open your terminal and run the following command to clone the repository to your local machine:

    git clone https://github.com/Emergency-Financial-Hotspot/web.git

Navigate into the Cloned Directory: Change your current directory to the cloned repository:

cd web

Install Dependencies: Install the necessary dependencies using npm:

npm install

Running the Project

Start the Development Server: After installing the dependencies, run the development server with the following command:

npm run dev

If you don't have a dev script defined, you can use:

http-server

Making Changes

Feel free to make changes to the project files. Once you've made changes, you can commit and push them back to the repository:

git add .
git commit -m "Your commit message"
git push

Instructions

  • Project Name: Emergency Financial Hotspot for Cashless Transactions.
  • Repository Link: https://github.com/ItsVicky25
  • Email Contact: [email protected]

This README text will guide users in setting up your project locally and provide them with troubleshooting tips, contribution guidelines, and contact information. If you need any more adjustments or additional sections, feel free to let me know!