-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4e22e1c
commit 39f8360
Showing
17 changed files
with
482 additions
and
105 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
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,28 @@ | ||
import React from 'react'; | ||
|
||
import Card from '../../app-components/card/card'; | ||
|
||
const apiURL = import.meta.env.DEV | ||
? 'http://localhost:8080' | ||
: import.meta.env.VITE_API_URL; | ||
|
||
const ApiHelp = () => ( | ||
<Card className='mt-2'> | ||
<Card.Body> | ||
<p> | ||
<strong className='pr-3'>Q:</strong>I want to view and interact with the API. Where can I find documetation for the API? | ||
</p> | ||
<p className='text-dark'> | ||
The API is hosted at the link below. Simply click the link to be directed towards the swagger documentation. The documentation | ||
is also interactable, requiring a Bearer token to authenticate and make requests with. | ||
</p> | ||
<hr /> | ||
<div> | ||
<p className='text-primary'>Click the link below to view the Swagger Documentation for the API:</p> | ||
<a href={`${apiURL}/swagger/index.html`} target='_blank' rel='noreferrer'>{apiURL}/swagger/index.html</a> | ||
</div> | ||
</Card.Body> | ||
</Card> | ||
); | ||
|
||
export default ApiHelp; |
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
Oops, something went wrong.