-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: base changes * feat: add docs route * feat: quick fix for docs routing * feat: docs page * feat: docs page * feat: light mode support * chore: improvement --------- Co-authored-by: Rotimi Best <[email protected]>
- Loading branch information
1 parent
f678243
commit 75c2655
Showing
16 changed files
with
753 additions
and
273 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <script lang="ts"> | ||
| const parameters = [ | ||
| { | ||
| name: 'page', | ||
| type: 'number', | ||
| description: 'Page number of repository e.g. 1 | 2 | 3', | ||
| }, | ||
| { | ||
| name: 'limit', | ||
| type: 'number', | ||
| description: 'Limit per page e.g. 10', | ||
| }, | ||
| { | ||
| name: 'sortBy', | ||
| type: 'string', | ||
| description: 'Sort by stars e.g. stars | author | forks', | ||
| }, | ||
| { | ||
| name: 'order', | ||
| type: 'string', | ||
| description: 'Order of sorting e.g. asc | desc', | ||
| }, | ||
| ]; | ||
| </script> | ||
|
|
||
| <section | ||
| class="border w-full rounded-md flex flex-col md:flex-row item-start gap-5 p-5" | ||
| > | ||
| <section class="md:w-2/4 w-full"> | ||
| <h1 class="text-xl">Get Repositories</h1> | ||
| <p class="text-sm mt-1">Get Repositories from the database</p> | ||
|
|
||
| <div class="border-2 rounded-md p-2.5 my-5 text-sm"> | ||
| <span class="bg-green-900 text-green-500 px-2 py-1 text-sm rounded-sm"> | ||
| GET | ||
| </span> | ||
| <span class="tracking-wide ml-1">/v1/repositories</span> | ||
| </div> | ||
|
|
||
| <h1 class="text-xl">Request</h1> | ||
| <p class="text-sm mt-2">Query Parameters</p> | ||
|
|
||
| {#each parameters as param} | ||
| <div class="≈p-2.5 mt-10 text-sm"> | ||
| <div class="flex items-center gap-5 mb-4"> | ||
| <p>{param.name}</p> | ||
| <p class="text-xs px-2 py-0.5 bg-red-50 text-black rounded-md"> | ||
| {param.type} | ||
| </p> | ||
| </div> | ||
|
|
||
| <p>{param.description}</p> | ||
| </div> | ||
| {/each} | ||
| </section> | ||
|
|
||
| <section class="md:w-2/4 w-full flex flex-col gap-5"> | ||
| <div | ||
| class="flex flex-col gap-3 bg-white dark:bg-transparent border dark:text-white rounded-md h-auto p-4 text-xs" | ||
| > | ||
| <p>curl --request GET \</p> | ||
| <p>--url https://api.naijastars.dev/v1/repositories \</p> | ||
| </div> | ||
|
|
||
| <div | ||
| class="bg-white dark:bg-transparent border dark:text-white rounded-md h-[75vh] overflow-y-auto" | ||
| > | ||
| <pre> | ||
| <code class="language-json text-xs"> | ||
| {`{ | ||
| "status": "success", | ||
| "data": [ [ | ||
| { | ||
| "id": 34, | ||
| "name": "chakra-ui", | ||
| "link": "https://github.com/chakra-ui/chakra-ui", | ||
| "description": "⚡️ Simple, Modular & Accessible UI Components for your React Applications", | ||
| "author": "chakra-ui", | ||
| "author_link": "https://github.com/chakra-ui", | ||
| "author_avatar": "https://avatars.githubusercontent.com/u/54212428?v=4", | ||
| "stars": 38073, | ||
| "topics": [ | ||
| "a11y", | ||
| "accessible", | ||
| "ark-ui", | ||
| "chakra-ui", | ||
| "component", | ||
| "css-in-js", | ||
| "dark-mode", | ||
| "design-system", | ||
| "react", | ||
| "react-components", | ||
| "reactjs", | ||
| "styled", | ||
| "ui-components", | ||
| "ui-library", | ||
| "uikit", | ||
| "wai-aria" | ||
| ], | ||
| "license": { | ||
| "key": "mit", | ||
| "url": "https://api.github.com/licenses/mit", | ||
| "name": "MIT License" | ||
| }, | ||
| "forks": 3285, | ||
| "open_issues_count": 12, | ||
| "archived": false, | ||
| "disabled": false, | ||
| "original_created_at": "2019-08-17T14:27:54.000Z", | ||
| "original_updated_at": "2024-12-03T07:58:40.000Z", | ||
| "created_at": "2024-12-01T14:44:03.981Z", | ||
| "updated_at": "2024-12-03T10:04:43.429Z", | ||
| "author_link_madeinnigeria": "https://twitter.com/thesegunadebayo", | ||
| "author_madeinnigeria": "@thesegunadebayo" | ||
| } | ||
| ] | ||
| }`} | ||
| </code> | ||
| </pre> | ||
| </div> | ||
| </section> | ||
| </section> |
Oops, something went wrong.