In our time building apps for customers, we've found ourselves re-rolling some of the same key features over and over again between projects. So we picked some of the things that kept popping up, implemented our own opinionated solutions for them, and then included it all in this free and open-source starter app. We hope it helps you as much as it helps us!
Built-in support for internal emails from the contact form, as well as transactional emails for users.
Ready-to-go, customizable sign up, login, and password recovery flows for your users.
Hook up to your Stripe account for managing customers and payment sources.
This starter app includes several different page templates (including the one you're reading right now) that you can change as much or as little as you like. If there are any pages you won't need, just remove them.
To get started, do a global find/replace in this project for occurrences of NEW_APP_NAME
and replace them all with the actual name of your app or platform (e.g. "Facebag"). Then do the same thing again to replace NEW_APP_COMPANY_NAME
with the actual name of your organization (e.g. "Facebag Corporation").
This app also includes a default Terms of Use and Privacy Policy. We want to make it easier for apps to be transparent about their users' rights and privacy. But we are developers, not lawyers; and this is definitely not legal advice. Before going live, be sure to replace these example documents with your own company's policies, and seek counsel for assistance if you need to design new terms from scratch.
In order for this app to send automated emails, you'll need to create a Sendgrid account. Then, in config/custom.js
, configure the following:
// Recipient of contact form messages
internalEmailAddress: my.email@example.com,
// For outgoing emails
fromEmailAddress: 'noreply@example.com',
fromName: 'The NEW_APP_NAME Team',
// Sendgrid settings
sendgridSecret: 'SG.fake.3e0Bn0qSQVnwb1E4qNPz9JZP5vLZYqjh7sn8S93oSHU'
To enable support for billing features, you'll need to make a Stripe account, then include your test credentials like so:
// Stripe credentials
stripePublishableKey: 'pk_test_Zzd814nldl91104qor5911gjald',
stripeSecret: 'sk_test_Zzd814nldl91104qor5911gjald'
If your app doesn't need payment processing, it will still work without Stripe configuration. In this case, all references to billing will just be omitted from the UI.
Once the initial configuration is done, you're ready to start building out the rest of your app.
We worked hard to make this starter app's structure consistent and its files are as bare-bones as possible, so it's easy to add new pages and business logic following the conventions we set up. If you run into trouble, have a look at your new FAQ page, which covers the tools we used and how to customize. For a deeper dive, check out the Sails walkthrough, reference documentation and support pages.
We think this project is a pretty convenient starting point, but of course there's no one-size-fits-all solution. The good news is, this app is in your hands now, so you can jump into the files and adapt it to your needs. Change some code around. Break stuff. Fix it. And above all: make something people want to use.