flatsheet/flatsheet-notes-js

a sample microblogging client for flatsheet

flatsheet-notes-js

a sample microblogging client for flatsheet

How to use flatsheet-notes-js

My plan is to use this for simple links + narrative sites, notebooks of important links about specific topics. It's inspired by sites like Quartz's Glass.

The approach this project uses (content loaded by browser javascript) isn't great if you require your microblog to be indexed by search engines, but for this kind of project, that may not actually be a requirement. (Also: search engines may be getting better at rendering js-heavy sites)

Set up

• Fork this repository
• Clone your fork to your local computer
• Create an account and sheet at flatsheet.io
• Run npm install inside the project folder
• Edit config.json to change the name, baseurl, sheet, limit, host, and token properties.
• Edit index.html and style.css to revise project name, css, and other project-specific details
• Commit your changes and push to your fork

Create a sheet

You'll be using this with Flatsheet, so go to app.flatsheet.io to create an account and a new sheet for this project.

Required columns

Your sheet at flatsheet.io must have title, content, and slug fields.

The slug field needs to contain strings that are a version of the title all in lowercase and separated by dashes.

config.json

Edit the config.json file to add the app name, the baseurl of your app, and the sheet slug from flatsheet.io.

You can also set the limit, which controls how many items are shown in the pagination.

Optionally, if you have your own instance of flatsheet running, you can set the host to that app's url.

{
  "name": "flatsheet-notes",
  "baseurl": "http://flatsheet.io/flatsheet-notes-js/",
  "sheet": "8-p2tdw53rwzx9nvr2g5oq'",
  "limit": 5,
  "host": ""
}

License

MIT