Building a persistent Notes app for Firefox OS

In this tutorial we will be building a notes app (like Evernote) from scratch and deploy it to Firefox OS! See a live demo.

A persistent notes app needs a place to store all the notes for a user (so no one else can read it). For this we will use my own backend solution called Sproute. Sproute is a hosted web framework for quickly building dynamic webapps.

First create an account with a unique subdomain then access the Dashboard through http://<mysubdomain> You must login with the same details used to signup to Sprotue.


In Sproute there is a concept called Models. A model defines the dynamic data in our app with properties for data integrity. Create a new model called notes with the following fields and properties:

  • body: Text, Required, Min: 1
  • sharing: Text, Allowed Values: public, private, Default Value: private
The model form filled out for notes

The model form filled out for notes

The body field will store the contents of the note. The sharing field will specify whether the note can be viewed by others (with a direct link) or just the owner. This is all the data we need to define, everything else is covered by built-in fields.

List notes

We need a way to list the available notes for a user. This can be done with Pages. A page is HTML with embedded template tags for retrieving and processing data.

Open the index page. This is the home page when people view your space. We will list the notes here. Add the following:

{{ get /data/notes?sort=_lastUpdated,desc as notes }}

All data is retrieved through an HTTP interface so the {{ get }} tag must take a URL. The request above is retrieving all notes for the logged in user and stores the results in a variable called notes. We use a query parameter to sort the results by last modified first (An underscore denotes a built-in field).

Let’s display each note in a list:

    {{ each notes as note }}
        <li><a href="/view/{{note._id}}">
        {{ word note.body 0 5 }}
    {{ / }}

The {{ word }} template tag will extract the first 5 words from the body content. We link to a not-yet-made page with the URL /view/<id>. note._id is a built-in unique identifier.

Add the above code in the 'index' page

Add the above code in the ‘index’ page

Create a note

Before creating the view page for a note, let’s make a new page for creating a note. Create a new page called create. Add the following HTML:

<form action="/data/notes?goto=/" method="post">
    <div><textarea name="body"></textarea></div>
    <div><select name="sharing">
        <option value="private">Private</option>
        <option value="public">Public</option>
    <button type="submit">Create Note</button>

Simple! As mentioned above, all data is retrieved and modified through an HTTP interface. This means we can use a simple HTML form to create a new note. The goto query parameter will redirect the user to that URL.

Because this is a new page we need to create a new route so the page is accessible. A route is a pattern for a requested URL that will render a page if matched. There will already be a route for the index page. Click Routes and create a new one with the following:

  • Route: /create, Page: create.
New route to 'create' page

New route to ‘create’ page

User login and registration

User accounts are built into Sproute but we still need to create a Register and Login page. Thankfully this is also a simple HTML form so create a new page called users and add the following:

<form action="/api/login?goto=/" method="post">
        <input type="text" name="name" />
        <input type="password" name="pass" />
    <button type="submit">Login</button>

You may add the Register form on the same page by copying the login form and replace the action attribute to /api/register. Create two new routes with the following:

  • Route: /login, Page: users
  • Route: /register, Page: users

View and update a note

Previously we created a link to view a note. This will also be where we let users modify the note. Create a new page called view and add the following:

{{ get /data/notes/_id/ admin as note }}
{{ if note.sharing eq private }}
    {{ if note._creator neq :session.user._id }}
        {{ error This note is private }}
    {{ / }}
{{ / }}
<form action="/data/notes/_id/{{}}?goto=/" method="post">
    <div><textarea name="body">{{note.body}}</textarea></div>
    <div><select name="sharing">
       <option value="private" selected>Private</option>
       <option value="public">Public</option>
    <button type="submit">Update Note</button>

We make a request to get the note data for the note that was passed into the URL (through the params object). The query parameter single=true will return just the object instead of a one item collection. admin will run the request with the specified user-type. Next we check whether the note is private. If so throw an error if the user is not the creator.

The update form is very similar to the create form. We only need to change the action to update notes where the _id matches the one in the URL.

This page requires a slightly complex route. We need to use a placeholder in the route so that /view/anything will still match the view page and store anything in a variable.

Create a route with the following:

  • Route: /view/:id, Page: view

Now you can see where comes from. params is an object for all placeholders in the route and the matched values.


The last important concept of Sproute is permissions. Permissions are just like routes where a requested URL matches a pattern but instead of pointing to a page, it validates against a required user type.

Click Permissions and add the following:

  • Method: GET, Route: /data/notes, User: Owner
  • Method: GET, Route: /data/notes/*, User: Owner

This will make sure the only notes listed will be ones the user has created (i.e. the owner). Because of the second permission, we needed to run the {{ get }} request as admin otherwise it would fail for everyone (except for admins and the creator) even if the note is public.

Adding a permission to retrieving notes

Adding a permission to retrieving notes

Firefox OS support

Sproute can very easily support hosted apps on Firefox OS by creating a page with the manifest JSON data and the route: /manifest.webapp.

Create a new page called manifest with the following:

    "name": "{{}}",
    "description": "A persistent notes app",
    "launch_path": "/",
    "icons": {
        "128": "/absolute/path/to/icon"

Create a Route with the pattern /manifest.webapp pointing to the manifest page.

We’re done! Test this in the app manager by using the link to the manifest ( Sproute is open-source and on GitHub under the Mozilla Public License v2 so you may clone the repo for private hosting.

Notes app at mobile width

Notes app at mobile width


Comments are now closed.

  1. yuktarth wrote on April 1st, 2014 at 23:05:

    how do I logout ?? O.o

    1. Louis Stowasser wrote on April 2nd, 2014 at 02:02:

      Take the user to /api/logout


Comments are closed for this article.