1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
docs/user-guides/asset-hosting/github.md

67 lines
3.6 KiB
Markdown

---
description: How to use Github for your NFT assets
---
# Github
### **Github**
GitHub can be used to host and share files. This allows you to easily share and collaborate on files, track changes using commits, and keep a history of updates. GitHub's hosting capabilities enable you make your content accessible on the web.
### **Prerequisites**
Create an account on [Github](https://github.com/). Users might also be asked to provide details and billing addresses that are outside of this tutorial's scope.
**Step 1 - Create a new repository on GitHub or navigate to an existing repository where you want to host your files.**
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.58.20.png" alt=""><figcaption><p>Create new repository</p></figcaption></figure>
Fill in the repository details. **Make sure your Repo is public.**
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.59.38.png" alt=""><figcaption><p>Make the repository public</p></figcaption></figure>
### Host Your File
**Step 2 - Upload a file**
Go to your repo in Github and above the list of files, select the Add file dropdown menu and click Upload files. Alternatively, you can use version control to push your file to the repo.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.50.27.png" alt=""><figcaption><p>Upload file on Github</p></figcaption></figure>
To select the files you want to upload, drag and drop the file or folder, or click 'choose your files'.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.51.14.png" alt=""><figcaption><p>Drag and drop new files on your GitHub repo</p></figcaption></figure>
In the "Commit message" field, type a short, meaningful commit message that describes the change you made.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.54.29.png" alt=""><figcaption><p>Commit changes</p></figcaption></figure>
Below the commit message field, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, then you should choose to create a new branch for your commit and then create a pull request.
After you make your commit (and merge your pull request, if applicable), then click on the file.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 07.56.01.png" alt=""><figcaption><p>Upload successful</p></figcaption></figure>
**Step 3 - Get the RAW version of your file**
To use your file on the Market **you need to use the raw url of the asset**. Also, make sure your Repo is publicly accessible to allow the market to use that file.&#x20;
Open the File and click on the "Raw" button on the right side of the page.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 08.02.25.png" alt=""><figcaption><p>Click the Raw button</p></figcaption></figure>
Copy the link in your browser's URL - it should begin with "https://raw.githubusercontent.com/...." like in the image below.
<figure><img src="../../.gitbook/assets/Raw-URL.png" alt=""><figcaption><p>Grab the RAW github URL from your browser's URL bar</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 08.05.41.png" alt=""><figcaption><p>Copy paste the raw url</p></figcaption></figure>
**Step 4 - Publish the asset using the Raw link**
Now, copy and paste the Raw Github URL into the File field of the Access page in the Ocean Market.
<figure><img src="../../.gitbook/assets/Screenshot 2023-06-16 at 08.08.12.png" alt=""><figcaption><p>Upload on the Ocean Market</p></figcaption></figure>
Et voilà! You have now successfully hosted your asset on Github and properly linked it on the Ocean Market.