Fredrick Emmanuel
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # Difference between WebRTC and WebSocket Communication is an essential part of our daily lives. Chat applications make it easy to interact with people around the world. These chat applications send chats in real-time. This is where WebRTC and WebSockets come into play. They grant us real-time communication, making the sending and receiving of chats done immediately. In this article, we will learn the difference between WebRTC and WebSockets by building a video chat application. # Prerequisites To follow effectively with the tutorial, be sure you have: - [Node.js](https://nodejs.org) installed. - Knowledge of [NextJS](https://nextjs.org/docs). - Code editor, preferably [Visual Studio Code](https://code.visualstudio.com/download). Now that all is set, let's learn about WebRTC and WebSocket. # What is WebRTC? Web Real-Time Communication (WebRTC) is a technology that enables real-time communication between/among web applications. It allows these web applications to capture video, audio, and other data without the use of a server. This means that WebRTC allows peer-to-peer communication amidst web browsers without the need for an intermediary(server). # What is WebSocket? WebSocket is a communication protocol that allows real-time communication between web browsers where the server is standing as an intermediary. This means that for communication to occur, a user needs to send the message to the server then the server sends that message to other users (Client-Server communication). # Difference between WebRTC and WebSocket WebRTC and WebSocket are technologies that grant real-time communication but vary in several ways. The major difference between WebRTC and WebSocket is that WebRTC doesn't need a server to carry out its real-time communication while WebSocket needs one. This makes WebRTC faster and preferable for video/audio communication. Despite WebRTC being faster than WebSocket, it primarily sends data over UDP which causes you to lose some packets of data. Since WebSocket uses TCP, it avails you with [data integrity](https://en.wikipedia.org/wiki/Data_integrity) and it's preferable for sending valuable information. # Overview of the video chat app Now that we know the difference between WebRTC and WebSocket, let's take a step further and learn how to use these technologies to build a video chat app. To build the video chat app, we will use WebRTC and WebSocket. We will use WebSocket to create the signal. Once they are connected, we can now use WebRTC to share the webcams of the connected users. ## How it works When the user connects, we would request video and audio permission from the user and display their stream on the page. From here, the user can either enter an existing room or create their room. Once the user creates the room, they would be provided with an `ID` which the other user would use to connect to their room. ## What happens in the background Once the user creates the room, we send an `emit` function to the server, the server creates the room and sends the user a random string, which will be used as the room `ID`. The other user will paste the `ID` and click on `Join Room`. We will return an error, if the `ID` provided doesn't have a room attached or if the room contains another user since we are building a video chat app for 2 users only. If no error was returned, we will emit an event to the host which will prompt the host to initiate the call. Once the call has been initialized, we will create an `offer` and send this `offer` to the server. Then the server will signal the other user, passing the `offer` as a parameter. The other user receives this `offer`, sets it as a `Remote Description`, and then emits its offer (`answer`) to the server. Once the server receives it, it will emit the `answer` to the host, the host will set the `answer` as its `Remote Description` and _voilà_ :tada: the connection is made. We have a better understanding of how the video chat app works, let's write some codes to see it in action. # Setting up the frontend Create a folder that will contain all the source code for this application. You can name it as desired, but the folder is named **video-chat-app** in this tutorial. Open this folder in VS Code and run the following command in the integrated terminal to create a NextJS application. ```bash npx create-next-app . ``` Once the next app has been created, we can run the command below to spin up the NextJS application. ```bash npm run dev or yarn dev ``` Now, we will install the dependencies that will be used in this application. ```bash npm i nanoid socket.io socket.io-client ``` `nanoid` - This will be used to create random strings. These random strings will be used as the `ID` for each user. `socket.io` and `socket.io-client` - This is used to signal the two different users. Next, run `npm run dev` to start the NextJS application. This application can be viewed at [localhost:3000](http://localhost:3000). ### Setting up the video chat interface We have our application up and running, we can now create our video chat interface. Open the `index.js` file in the `pages` folder and replace the default code in the `index.js` file with the one below. ```js // pages/index.js import { useEffect, useRef, useState } from 'react'; export default function App() { const [errorSetting, seterrorSetting] = useState(''); const myVideoRef = useRef(); //Your video const peerVideoRef = useRef(); //The other users video const myStreamRef = useRef(); //Our video stream const [done, setdone] = useState(false); useEffect(() => { //Getting our Video and Audio navigator.mediaDevices .getUserMedia({ audio: true, video: true, }) .then(stream => { myStreamRef.current = stream; //Storing our video myVideoRef.current.srcObject = stream; }) .catch(err => { /* handle the error */ console.log(err); }); }, []); return ( <> <div className="container"> <div> <video autoPlay ref={myVideoRef} muted playsInline width={'500px'} /> <h1>User</h1> </div> <div> <video autoPlay ref={peerVideoRef} playsInline width={'500px'} /> {done && <h1>Peer</h1>} </div> </div> <h1>{errorSetting}</h1> </> ); } ``` From the above lines of code, We requested for the user's video and audio stream and then stored it in `myVideoRef`. Once the stream is got, we returned the video with a little style. > This tutorial would focus more on the video chat functionality than beautification. So, feel free to design the video chat app to your taste. Let's add a little styling to the application. Open the `globals.css` file in the `styles` folder and add the following. ```css /* styles/globals.css */ .container { display: grid; grid-template-columns: 3fr 1fr; } .div { margin: auto; width: 30%; display: grid; grid-template-columns: 1fr; } input { border-radius: 0; padding: 10px 15px; width: 100%; } .center { margin: auto; width: 50%; } button { width: 100px; height: 50px; border-radius: 10px; } html, body { font-family: 'Roboto', sans-serif; padding: 0; margin: 0; } * { box-sizing: border-box; } button:focus { outline: 0; } ``` # Setting up the server In this section, we would create the socket server and develop the signalling service for the video chat app. Create a file named `socket.js` in the `pages/api` directory and add the following lines of code. ```js // pages/api/socket.js import { Server } from 'socket.io'; import { customAlphabet } from 'nanoid'; const nanoid = customAlphabet('1234567890abcdef', 6); const SocketServer = (req, res) => { if (res.socket.server.io) { console.log('Socket is created'); return res.end(); } const io = new Server(res.socket.server); res.socket.server.io = io; io.on('connection', socket => { let id = nanoid(); //Creating the room socket.on('create-room', () => { //Sending the room ID to the host. socket.emit('me', id); socket.join(id); socket.emit('created'); }); //Joining a room socket.on('join-room', id => { const { rooms } = io.sockets.adapter; const room = rooms.get(id); //Checking if the room existing if (room === undefined) { socket.emit('not-existing'); } else if (room.size === 1) { //Joining the other user to the room that contains only the host socket.join(id); // socket.broadcast.to(id).emit('ready', id); } else { // Returns an Error since they are already two in the room socket.emit('full'); } }); //Once we get the offer from the host, we will send it to the other user socket.on('offer', (offer, roomId) => { console.log('offer', roomId); socket.broadcast.to(roomId).emit('offer', offer, roomId); }); //Once we get an icecandidate from the user, we will send it to the other user socket.on('ice-candidate', (candidate, roomId) => { console.log('icecandidate', roomId); socket.broadcast.to(roomId).emit('ice-candidate', candidate); }); //Once we get an answer from the other user, we will send it to the host. socket.on('answer', (answer, roomId) => { console.log('answer', roomId); socket.broadcast.to(roomId).emit('answer', answer); }); }); return res.end(); }; export default SocketServer; ``` This is all we need to create the signalling from our server. Next, we would create the signalling from our front end. # Adding the frontend signal Open your `index.js` file in the `pages` folder and add the following to listen to all events, emitted from our server. First, we would initialize the socket for the front end. ```js //pages/index.js import { useEffect, useRef, useState } from 'react'; import { io } from 'socket.io-client'; const useSocket = () => { const socket = useRef(); useEffect(() => { if (!socket.current) { const socketInitializer = async () => { await fetch('/api/socket').then(() => { console.log('connected'); }); }; try { socketInitializer(); socket.current = true; } catch (error) { console.log(error); } } }, []); }; export default function App() { //Calling the useSocket function useSocket() //... } ``` > The 3 dots `...` in the code block means missing lines of code. Next, we will create a `useEffect` function containing all our socket listening events. ```js //pages/index.js import { useEffect, useRef, useState } from 'react'; import { io } from 'socket.io-client'; //... export default function App() { //Calling the useSocket function useSocket(); const [errorSetting, seterrorSetting] = useState(''); const connectionRef = useRef(null); //The peer connection const [roomId, setRoomId] = useState(''); //The roomID const socket = useRef(); //The socket instance const myVideoRef = useRef(); //Your video const peerVideoRef = useRef(); //The other users video const myStreamRef = useRef(); //Our video stream const host = useRef(false); //Host instance const [done, setdone] = useState(false); //... useEffect(() => { socket.current = io(); //Getting the `roomId` from the server socket.current.on('me', roomId => { //Saving the roomId got from the server setID(roomId); }); //Listening for a `full` event from the server socket.current.on('full', () => { seterrorSetting('Room is filled'); }); //Listening for a `not-existing` event from the server socket.current.on('not-existing', () => { seterrorSetting("Room doesn't exist"); }); //Setting the host socket.current.on('created', () => (host.current = true)); //Starting the video call when we receive a ready event socket.current.on('ready', startCall); /* WebRTC */ //Getting the offer socket.current.on('offer', receiveOfferHandler); //Getting the answer socket.current.on('answer', handleAnswer); //Getting the icecandidate socket.current.on('ice-candidate', newIceCandidate); return () => socket.current.disconnect(); }, [roomId]); //... } ``` Let's create the handlers for these listening events. ```js //page/index.js import { useEffect, useRef, useState } from 'react'; import { io } from 'socket.io-client'; //... export default function App() { //... const startCall = roomiid => { console.log('call initiated'); }; const receiveOfferHandler = (offer, roomiid) => { if (!host.current) { } }; const handleAnswer = answer => { if (host.current) { console.log('receiving answer'); } }; const newIceCandidate = incomingIce => { console.log('receiving new icecandidate'); }; //... } ``` # Creating the Peer Connection Now let's get started with WebRTC. To make use of WebRTC, we need to make use of ICE Servers. An interactive Connectivity Establishment (ICE) Server is a protocol used to establish a peer-to-peer connection between two browsers in WebRTC applications. It majorly makes use of Session Traversal Utilities for NAT ([STUN](https://en.wikipedia.org/wiki/STUN)) and Traversal Using Relays around Nat ([TURN](https://en.wikipedia.org/wiki/TURN)) for media communication. > [Click here](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Protocols) to know more about ICE Servers There are many [public ICE Servers](https://gist.github.com/sagivo/3a4b2f2c7ac6e1b5267c2f1f59ac6c6b) you can pick from, but for this tutorial, we will make use of the [OpenReplay](https://www.metered.ca/tools/openrelay/) ICE Servers. To add this ICE Server, open the `index.js` file and add the lines of code below. ```js //pages/index.js import { useEffect, useRef, useState } from 'react'; import { io } from 'socket.io-client'; //Public IceServer: https://www.metered.ca/tools/openrelay/ const IceServer = { iceServers: [ { urls: 'turn:openreplay.metered.ca:443', username: 'openreplayproject', credential: 'openreplayproject', }, ], }; //... ``` Once a user gets the `room ID` and clicks on the `Join Room` button, we will create functionality that will enable the host to start the video call. Let's create the functionality that will enable users to create and join a room in the `index.js` file. ```js //pages/index.js import { useEffect, useRef, useState } from 'react'; import { io } from 'socket.io-client'; //... export default function App() { //Calling the useSocket function useSocket(); const [errorSetting, seterrorSetting] = useState(''); const [id, setID] = useState(); //Your roomID //... const roomCreate = () => { //Signaling the server to create a room socket.current.emit('create-room'); }; const joinRoom = () => { //Signaling the server to join the user to the room socket.current.emit('join-room', roomId); }; return ( <> <div className="container"> <div> <video autoPlay ref={myVideoRef} muted playsInline width={'500px'} /> <h1>User</h1> </div> <div> <video autoPlay ref={peerVideoRef} playsInline width={'500px'} /> {done && <h1>Peer</h1>} </div> </div> <div className="div"> <button onClick={roomCreate} style={{ marginBottom: '10px' }}> Create Room </button> {id && <h2>Copy Id: {id}</h2>} <input type="text" value={roomId} onChange={e => setRoomId(e.target.value)} style={{ marginBottom: '20px' }} /> <button onClick={joinRoom}>Join Room</button> <h1>{errorSetting}</h1> </div> </> ); } ``` Next, we will create a new function that will handle the creation of a new [`RTCPeerConnection`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection), which helps to create peer connections. ```js //pages/index.js //... export default function App() { //... const peerConnection = () => { // Creating the Peer Connection const connection = new RTCPeerConnection(IceServer); //Getting the icecandidate from the IceServer connection.onicecandidate = e => { console.log('icecandidate'); if (e.candidate) { //when it receives the ice candidate, it sends the ice candidate to the server socket.current.emit('ice-candidate', e.candidate, roomId); } }; //Getting the streams. connection.ontrack = e => { console.log('track receiving', e); //When it receives the peer's video, it stores the stream in peerVideoref peerVideoRef.current.srcObject = e.streams[0]; }; return connection; }; //... } ``` ## Starting the video call After creating the `peerConnection` function, we will edit the `startCall` function and create a new peer connection using the `peerConnection` function. ```js //pages/index.js //... export default function App() { //... const peerConnection = () => { //... } const startCall = roomiid => { console.log('call initiated'); if (host.current) { //Setting the host's peerConnection connectionRef.current = peerConnection(); myStreamRef.current.getTracks().forEach(element => { //Storing the stream of the host in the peerConnection connectionRef.current.addTrack(element, myStreamRef.current); }); //Creating the offer connectionRef.current .createOffer() .then(offer => { connectionRef.current.setLocalDescription(offer); //Sending the offer to the server socket.current.emit('offer', offer, roomiid); }) .catch(error => { console.log(error); }); } }; //... } ``` Above, we created a new peer connection, stored our video stream in the peer connection, created an `offer` using the peer connection and emitted the offer to the server. ## Receiving the offer Once the server receives the offer, it sends the `offer` to the other peer. Now, let's receive the `offer` and emit the other peer's answer. ```js //pages/index.js //... export default function App() { //... const peerConnection = () => { //... } const startCall = roomiid => { //... } //... const receiveOfferHandler = (offer, roomiid) => { if (!host.current) { //Setting the other user's peerConnection connectionRef.current = peerConnection(); myStreamRef.current.getTracks().forEach(element => { //Storing the stream of the other user in the peerConnection connectionRef.current.addTrack(element, myStreamRef.current); }); //Storing the host's offer that was received. connectionRef.current.setRemoteDescription(offer); //Create an answer connectionRef.current .createAnswer() .then(answer => { connectionRef.current.setLocalDescription(answer); //Sending the answer to the server socket.current.emit('answer', answer, roomiid); setdone(true); }) .catch(error => { console.log(error); }); } }; //... } ``` As seen above, we got the host's `offer` from the server, stored it as the other user's `remote description`, created an `answer` and sent this `answer` to the server. ## Receiving the answer Immediately after the server receives the `answer`, it sends the `answer` to the host. Let's receive the `answer` and set it as the host's `remote description`. ```js //pages/index.js //... export default function App() { //... const peerConnection = () => { //... } const startCall = roomiid => { //... } const receiveOfferHandler = (offer, roomiid) => { //... } const handleAnswer = answer => { if (host.current) { console.log('receiving answer'); setdone(true); connectionRef.current .setRemoteDescription(answer) .catch(err => console.log(err)); } }; //... } ``` ## Adding the ice candidate Lastly, we need to add the incoming `ice-candidate` to the peer connection. ```js //pages/index.js //... export default function App() { //... const peerConnection = () => { //... } const startCall = roomiid => { //... } const receiveOfferHandler = (offer, roomiid) => { //... } const handleAnswer = answer => { //... } const newIceCandidate = incomingIce => { console.log('receiving new icecandidate'); const candidate = new RTCIceCandidate(incomingIce); connectionRef.current .addIceCandidate(candidate) .catch(err => console.log(err)); }; } ``` You can view and test out the application at [localhost:3000](http://localhost:3000/). # Deploying the application It's time to deploy our application. There are various services out there that we can use to deploy our NextJS application. We can't use [Vercel](https://vercel.com) because it doesn't support the use of WebSockets at the time of writing this article. We would have used [Heroku](https://www.heroku.com/) but Heroku doesn't have a [free tier anymore](https://help.heroku.com/RSBRUH58/removal-of-heroku-free-product-plans-faq). The best option we can use is Render. [Render](https://render.com/) is a unified cloud to build and run all your apps and websites with free TLS certificates, a global CDN, DDoS protection, private networks, and auto deploys from Git. Visit the [official Render website](https://render.com/) to create a free account. You choose to sign up with Google, GitHub, GitLab, or your email address. Once you've signed up, click on the **New +** button close to your avatar and select **Web Service** to create a new application. ![New Web service](https://i.imgur.com/4Rocssm.jpg) > Ensure you have deployed your source code to [GitHub](https://github.com) Link your GitHub account and **Connect** your desired repository. ![Connect Repo](https://i.imgur.com/ARggrpc.jpg) Next, enter a unique name for the application. In this tutorial, the name of the application is **openreplay-video-chat** so choose something different. ![Naming application](https://i.imgur.com/rriVcaJ.png) > Make sure that your repository root folder is the NextJS folder. If the NextJS application's folder is in another folder, visit [render's docs](https://render.com/docs/monorepo-support#root-directory) for directions. Scroll down to **Build Command** and edit the build command using `npm install && yarn build`. ![Build Command](https://i.imgur.com/5D2HQiG.jpg) Once that is done, click on the **Free** tier, scroll to the bottom and click on **Create Web Service** to deploy the application. ![Deploying Web Service](https://i.imgur.com/Sh1JLm3.jpg) Once it is done installing all dependencies and building the NextJS application, you will get an output similar to the one below. ![Deploying Done](https://i.imgur.com/jSIEe1v.png) # Conclusion We have come to the end of this tutorial. In this tutorial, we learned about WebRTC and WebSockets and use this knowledge to create a video chat application. The complete code for this project [can be found here](https://github.com/divofred/video-chat-app).

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully