-
Notifications
You must be signed in to change notification settings - Fork 0
/
Readme
44 lines (26 loc) · 998 Bytes
/
Readme
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# GitHub API Backend
This project is a backend micro-service that makes calls to GitHub organizations and get their last repositories with issues and pull requests
## Getting Started
### Prerequisites
- Node.js or Docker installed
- GitHub Developer Account for obtaining an access token
### Installation
1. Clone the repository:
git clone https://github.com/omarsoufiane/github-gateway.git
2. Navigate to the repository:
cd github-gateway
3. Install dependencies:
npm install
### Configuration
Create a .env file in the root of the project and put the token you obtained from GitHub:
GITHUB_ACCESS_TOKEN=your_actual_access_token
PORT=3000
### Usage
1. Using npm:
npm run build
npm run start
2. Using Docker:
docker build -t your-image-name .
docker run -p 3000:3000 your-image-name
The server will be running at http://localhost:3000 by default.
Make get request to 'http://localhost:3000/orgs/{organisation-name}/' to get organisation informations