Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.11 KB

INSTALL.md

File metadata and controls

63 lines (40 loc) · 1.11 KB

How to Set Up GameVault Backend for Local Development

What You Need

Items with an asterisk (*) are optional, but recommended.

Steps to Get Started

  1. Clone the Repository

    Open your terminal and run:

    git clone https://github.com/Phalcode/gamevault-backend
  2. Go to the Project Folder

    Navigate to the directory you just downloaded:

    cd gamevault-backend
  3. Install the Required Dependencies

    Install all necessary packages:

    pnpm install
  4. Set Up Your Environment

    Copy the sample environment file:

    cp .dev.env .env
  5. Start the App or Run Tests

    To start the app:

    pnpm start

    To run tests:

    pnpm test

Contributing

Before contributing, please review and agree to the Contributors License Agreement and the License.