CONTRIBUTING.md

Contributing to GitLang

Local development

Clone repository

HTTPS

git clone https://github.com/chiefmikey/gitlang.git

SSH

git clone [email protected]:chiefmikey/gitlang.git

API Authentication

Create a GitHub Personal Access Token (PAT) with the public_repo scope.

Create a .env file in the root of the project with the following contents:

GITHUB_PAT=<your PAT>

Make sure the .env file is not tracked in Git.

Install Dependencies

npm install

Build

Development

npm run build:dev

Production

npm run build:prod

Start Server

npm run start:server

Start Client

npm run start:client

Client will be available in the browser on local port 8080