appmaker

by mozilla-appmaker

mozilla-appmaker / appmaker

Appmaker was an exploration in making app authoring available to non-developers

423 Stars 189 Forks Last release: Not found Mozilla Public License 2.0 2.9K Commits 26 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

This project is no longer under active development.

Read about why, here: https://blog.webmaker.org/product-update-for-appmaker-and-popcorn-maker

Appmaker

Build Status devDependency Status

Welcome to Appmaker (beta).

Appmaker is a tool that helps anyone, not just developers, create mobile applications.

Appmaker apps are composed of web components, custom/resusable HTML tags, connected with events and listeners.

To learn more about web components, check out the Polymer Project.

More resources:

Getting Started

This section covers how to get Appmaker running locally. The workflow is optimized for contributors.

Dependencies

Make sure you have

nodejs
,
npm
, and
git
installed.

grunt
is required to run the test suite. To install grunt on unix and OS X, run
sudo npm install -g grunt-cli
.

We manage client-side dependencies using bower. In order to add/remove these dependencies, you need to have

bower
installed globally on your machine, which can be done on unix and OS X via
sudo npm install bower -g
.

Webmaker Login is required to log into the app. Follow these instructions exactly to run it locally

Forking And Cloning The Repository

Create a root

mozilla-appmaker
directory:
mkdir mozilla-appmaker
cd mozilla-appmaker

Fork this repository, and then clone your fork into the

mozilla-appmaker
directory:
git clone [email protected]:/appmaker.git appmaker

Your directory structure should look like this:

mozilla-appmaker/
  ├── appmaker/

Configure remote:

cd appmaker
git remote add upstream [email protected]:mozilla-appmaker/appmaker.git
git fetch upstream

Environment Setup And Configuration

Install Node packages:

npm install

Configure your env: ``` cp sample.env .env

A short explanation of a complete `.env` file:

PRODUCTION: OPTIONAL - if this value is set, app.js will ignore "dev only" code paths BUNDLE: OPTIONAL - if this has any value, components will be bundled into a single mozilla-appmaker.min.html file in ./public/bundles/components (modifying individual components will then only take effect on app start) BUNDLEMINIFY: OPTIONAL - if this has any value, it will also minify the resulting bundle(s) MONGOURL: REQUIRED - the URI for your mongod instance and database, for example mongodb://localhost/appmakerdev (or whatever your database is named) LOGINAPI: REQUIRED - The URI of a Webmaker login server to use for user authentication. for exmaple http://localhost:3000 LOGINAPIWITHAUTH: - The URI of a Webmaker login server, including basic authentication credentials. for exmaple http://testuser:[email protected]:3000 COOKIESECRET: A long, complex string for cookie encryption (NOTE: You define this for your local use, the string can be anything). FORCESSL: If using SSL, set this to true. STORE: Storage approach for publishing apps.

local
is the default,
s3
requires additional environment variables (prefixed by S3) S3BUCKET: S3 bucket name. e.g. "my.coolappmaker.com" S3KEY: An access key for the S3 bucket listed above. S3SECRET: The secret corresponding to the specified S3 access key. S3OBJECTPREFIX: String to prepend S3 objects. Useful for storing objects in folders. E.g. "level1/level2" => /level1/level2/. PUBLISHURLPREFIX: String to prepend to filenames that are saved when publishing. Try use the URL that matches the protocol from which assets are hosted to avoid mixed content blockage. REDIRECTURL: The hostname and port that we want to redirect to for Appmaker PORT: The port that the web process listens on for incomming connections EXCLUDEDCOMPONENTS: A comma-delimited list of component repositories to exclude from the mozilla-appmaker org. The name is the repo name rather than the component name, though this is usually the same. ALLOWCUSTOMCOMPONENTS: Optional flag to turn on using custom component for testing purposes (any value that coerces to true is accepted) BUNDLE: Any non-null value will cause the application to bundle as many resources as possible HSTSDISABLED: if set to "true", HSTS is disabled. **(If you are not forcing SSL, you should turn disable HSTS by setting HSTSDISABLED='true' in the .env)** DISABLEXFOHEADERSDENY: If set to "true", X-Frame-Options Headers are not set. If not set to "true" / left unset, XFO headers are set to DENY. IEXSSPROTECTIONDISABLED: If set to "true", iexss vulnerability headers are not set. If set to false or left unset, iexss protection for IE8 will be enabled. GAACCOUNT: Optional google analytics account setting. (https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration#gat.GATracker.setAccount) GADESIGNERDOMAIN: Optional google analytics domain setting for the designer. (https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiDomainDirectory#gat.GATracker.setDomainName) GAPUBLISHDOMAIN: Optional google analytics domain setting for the published apps. (https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiDomainDirectory#gat.GATracker.setDomainName) PUBLISHHOST: Host of URL which points to a published app. Does not include a protocol prefix (e.g.
http://
). Use
{{ip}}
in this string to automatically insert your machine's IP address (useful for debugging apps on mobile devices in dev environment). ASSET
HOST: URL used to provide assets to published apps. Use
{{ip}}
in this string to automatically insert your machine's IP address (useful for debugging apps on mobile devices in dev environment). PUBLISHHOSTPREFIX: Prefix of URL which points to a published app. Usually
http://
or
https://
. POSTMARKAPIKEY: An API key that needs to match a valid Postmark API key. POSTMARKFROMADDRESS: A valid email address that acts as the "from" address on emails sent out to users. This address must be added to the Sender Signature list associated with the Postmark API key provided in
POSTMARK_API_KEY
POSTMARKINBOUNDADDRESS: The "inbound email address" associated with the Postmark API key provided in
POSTMARK_API_KEY
POSTMARKSMTPSERVER: The SMTP server used by Postmark (default:
smtp.postmarkapp.com
) ```

Install and Run MongoDB

MongoDB is used for saving the user-created apps before publishing.

Installation

Visit http://docs.mongodb.org/manual/installation/ for platform-specific installation instructions. Be sure an install MongoDB outside of your local Appmaker repo.

Running
mongod

Either configure MongoDB to run on startup or manually start the mongod daemon.

To manually start

mongod
once it is installed:
mongod

The

mongod
process will, by default listen on port 27017. If you have it configured to listen on an alternate port, be sure to adjust your
MONGO_URL
in your
.env
file.

Start the Server

node app

How you can help

Component Development

So you want to make a component? That's great, we want to work with you! Here's a guide where you can learn what components are, how they are built, how to make your own and finally how to submit your finished component to Appmaker.

Guide to Contributing a Component

Technical reading: https://github.com/mozilla-appmaker/appmaker/blob/develop/public/ceci/README.md

Ceci is a set of foundational elements used in a AppMaker app, implemented as a set of Polymer components. If you create a new component, it's really an HTML tag that Polymer processes and then injects a variety of capabilities into that tag / JS object

Example AppMaker Component

TODO link to the Counter example, provide explanation

Submitting A Pull Request

Switch to develop branch:

cd mozilla-appmaker/appmaker
git checkout develop

Pull the latest version:

git pull

Create a new branch (for example a feature branch):

git checkout -b your-feature-branch-name

Make changes to the local copy, commit your changes, and then make sure your patch still works with latest version of develop branch:

git checkout develop
git pull
git checkout your-feature-branch-name
git rebase develop

Test commits:

grunt

Submit changes:

git push origin your-feature-branch-name

Submit the pull request at https://github.com/mozilla-appmaker/appmaker. For more assistance, see Github's help page on creating a pull request.

Localization

Appmaker uses the Webmaker-i18n module for localization of both the designer and (ceci) components.

Localizating component

If you have created your own component, see: https://github.com/mozilla-appmaker/appmaker/wiki/How-components-are-built#localization

Help on translation

Spotted any typo or want to help translate appmaker into your own language?

Appmaker uses Transifex for translation platform. You can check this how to article if you want to contribute for translation and visit Appmaker on Transifex to start translate.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.