Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #16

Merged
merged 3 commits into from
Sep 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 42 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ This route returns a JSON array of objects containing details of GitHub communit
"name": "John Doe",
"username": "johndoe123",
"profile_url": "https://github.com/johndoe123/profile.jpg",
"followers": 1000,
"following": 500,
"repositories": 50,
"followers": "1000",
"following": "500",
"repositories": "50",
"bio": "I'm a software engineer."
// ... Other details
},
Expand All @@ -66,6 +66,43 @@ This route returns a JSON array of objects containing details of GitHub communit
}
```

## Route 3: /members/:username

This route returns a JSON object containing details of a specific GitHub community member. The details provided include:

- `name`: Name
- `username`: GitHub username
- `profile_pic_url`: Profile picture URL
- `followers`: Number of followers
- `following`: Number of people they follow
- `repositories`: Number of repositories
- `bio`: Bio
- `github_link`: GitHub profile URL

**Example Response:**

```http
GET /members/PRATHAM1ST
```

```json
{
"status": true,
"data": {
"name": "Pratham",
"username": "PRATHAM1ST",
"github_link": "https://github.com/PRATHAM1ST",
"profile_pic_url": "https://avatars.githubusercontent.com/u/52632050?v=4",
"followers": "11",
"following": "13",
"repositories": "48",
"bio": "Interested in Web Development and Coding! ",
// ... Other details
},
"message": "Member found"
}
```

## Using the API

To interact with this API, simply send a GET request to the appropriate route. For example, to retrieve the list of community members, send a GET request to `/members`.
Expand Down Expand Up @@ -98,5 +135,7 @@ We use Jest for testing. You can run the tests with `npm test`.
- Jest
- Morgan
- Nodemon
- ESLint
- Dotenv

That's it! You are now ready to use our API to access community member data or explore other available routes. If you have any questions or encounter issues, feel free to reach out to us. Happy coding!