Welcome to the GitHub Repository System project! This guide will walk you through the steps required to set up the project on your local machine.
- Git
- Node.js
- NestJS CLI (You can install it using
npm install -g @nestjs/cli
)
-
Clone the Repository
Start by cloning the repository from GitHub.git clone https://github.com/mssnzz/RepoBackend.git
-
Navigate to the Project Directory
Once the repository is cloned, navigate into the directory.cd RepoBackend
-
Install Dependencies
Install the necessary project dependencies using npm.npm install
To make the GitHub controller function correctly, you'll need to provide your GITHUB_TOKEN
.
- Locate the
.env
file in the root directory of the project. - Add your GitHub token next to the
GITHUB_TOKEN
variable.
GITHUB_TOKEN=your_github_token_here
To run the project, you can use the NestJS CLI:
nest start
Or if you can use npm:
npm run start