liff-react-boilerplate

Starter Kit for ReactJs developer to run and learn LINE Frontend Framework (LIFF)

Prerequisites

• A channel on the LINE Developers Console for your application.
• A channel access token

How it work

This project build from create-react-app and bootstrap. Then add Line Frontend Framework (LIFF) SDK and also provide LiffHelper and messagingApiHelper to help in communicate with LINE LIFF Platform.

• There's also a version build with styled-system that makes you design and systemize your own style or theme more easily: liff-react-boilerplate, enjoy and feel free to report any bug or suggestion~:)

Install

Clone and run

npm install

Create config file in JSON and named it as config.json

{
  "line": {
    "channelAccessToken": "YOUR_CHANNEL_ACCESS_TOKEN"
  }
}

Run

npm start

then you can access http://localhost:3000

Demo

Profile : http://localhost:3000

SendMessage : http://localhost:3000/message

LIFF Window : http://localhost:3000/window

API

Get Profile

Utility class liffHelper automatic initial LIFF when application launched. You can get user profile with command

liffHelper.getProfile().then(profile => {
  // do something
});

Get LIFF Info

Get User Context information

liffHelper.getLIFFInfo()

return result

Send Message

const message = messagingApiHelper.createTextMessage('text')
liffHelper.sendMessages(message)

LIFF Window

liffHelper.openWindow('https://url.com', false)   // open url in LINE browser
liffHelper.openWindow('https://url.com', true)    // open url in external browser
liffHelper.closeWindow()                          // close LIFF window

Author

Sitthi Thiammekha

Deploy as a server

* Note. due to the issue of conflict of same required dependencies between StoryBook v5 and CRA v2, althogth it works on local build but failed on heroku. And I couldn't find out what cause the problem yet, sorry about that~ :(

Prerequisites

• A Heroku account

Deploying the application

1. Click the above "Deploy to Heroku button".
2. Fill in the required information on the "Create a New App" page in Heroku.
3. Select Deploy app and confirm that your app is successfully deployed.
4. Record the app URL (https://{Heroku app name}.herokuapp.com). You will set this URL when you add the app to LIFF.

Adding the starter app to LIFF

Add the app to LIFF. For more information, see Adding a LIFF app.

Running the application

1. To run this application, host these files on a web server.
2. Set your LIFF's entryUrl to point to index.html.
3. Open your LIFF in the LINE app.

Trying it out

To open the LIFF app within the LINE app, follow the steps below.

1. Tap line://app/{liffId} on the chat screen of the LINE app. {liffId} is the LIFF app ID returned to the API request to add the app to LIFF.

2. Agree to grant the required permissions to the LIFF app.

3. When opening the LIFF app, the following four buttons and the content of received information are displayed.

   • Open Window: Opens https://line.me in the in-app browser of the LINE app.
   • Close Window: Closes the LIFF app.
   • Get Profile: Gets the current user's profile.
   • Send Messages: Sends a sample message on behalf of the user if the LIFF app is opened in the chat screen.

For API calls associated with the buttons, see Calling the LIFF API. For the received information, see Initializing the LIFF app.

Checking logs

To get more information, you can check the logs of your app using Heroku CLI.

1. Log in to Heroku from the command line.

   $ heroku login

2. Check the logs.

   $ heroku logs --app {Heroku app name} --tail

Downloading and making changes to the starter app

You can download the starter app to your local machine to test and make changes for yourself. You can then deploy the app to a web server of your choice. Here, we'll look at how to make and deploy changes to the Heroku app you created in the previous step.

1. Make sure you have the following installed

   • Git

2. Clone the line-liff-starter GitHub repository.

   git clone https://github.com/line/line-liff-starter.git

3. cd into your Git directory.

4. Add a remote for Heroku to your local repository.

   $ heroku git:remote -a {Heroku app name}

5. Make edits and commit changes (optional).

   $ git add .
   $ git commit -m "First commit"

6. Push changes to Heroku master.

   $ git push heroku master