Items with an asterisk (*) are optional, but recommended.
-
Clone the Repository
Open your terminal and run:
git clone https://github.com/Phalcode/gamevault-backend
-
Go to the Project Folder
Navigate to the directory you just downloaded:
cd gamevault-backend
-
Install the Required Dependencies
Install all necessary packages:
pnpm install
-
Set Up Your Environment
Copy the sample environment file:
cp .dev.env .env
-
Start the App or Run Tests
To start the app:
pnpm start
To run tests:
pnpm test
Before contributing, please review and agree to the Contributors License Agreement and the License.