Skip to content

Latest commit

 

History

History
121 lines (65 loc) · 2.45 KB

README.md

File metadata and controls

121 lines (65 loc) · 2.45 KB

Payzing

Introduction

Frontend Installation

Follow these steps to set up Payzing on your local machine:

Prerequisites

Ensure you have Node.js and npm installed on your system. You can download Node.js from here.

Step 1: Clone the Repository

Open your terminal and clone the Payzing repository:

git clone https://github.com/yourusername/payzing.git

Navigate into the project directory:

cd payzing/frontend

Step 2: Install Dependencies

Install the project dependencies using npm:

npm install

This command installs all the necessary packages listed in the package.json file, including React, Vite, and other dependencies.

Step 3: Run the Development Server

Start the development server:

npm run dev

This command runs the Vite development server, which will automatically open your default web browser to the application.

Backend Installation

To set up the backend for Payzing, follow these steps:

Prerequisites

Ensure you have Node.js and npm installed on your system. You can download Node.js from here.

Step 1: Clone the Repository

Open your terminal and clone the Payzing repository:

git clone https://github.com/yourusername/payzing.git

Navigate into the backend directory:

cd payzing/backend

Step 2: Install Dependencies

Install the project dependencies using npm:

npm install

This command installs all the necessary packages listed in the package.json file, including Express, CORS, and other dependencies.

Step 3: Environment Setup

Create a .env file in the root of the backend directory and add your environment variables. For example:

PORT=3001

Step 4: Run the Development Server

Start the development server:

npm run dev

This command runs the server using Nodemon, which will automatically restart the server whenever you make changes to the code.

Contributors

License

Payzing is licensed under the MIT License. See the LICENSE file for more details.