Skip to content

Commit 0f7cde5

Browse files
Merge pull request #10 from Authmaker/feature/overview
Feature/overview
2 parents 2a9ecea + 8f0b7cc commit 0f7cde5

File tree

10 files changed

+59
-12
lines changed

10 files changed

+59
-12
lines changed

deployment/gcloud-deploy.md

Whitespace-only changes.

deployment/production-databases.md

Whitespace-only changes.

getting-started/overview.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,21 @@
22
title: Overview
33
---
44

5-
TODO: Explain overview here perhaps and default to this page when clicking on 'Guides' link?
5+
Authmaker provides simple tools for building backend applications with secure authentication and payment processing - all designed to work with Ember straight out of the box.
6+
7+
## Using Authmaker
8+
9+
New to backend development? No problem! Authmaker was designed to be an inclusive platform. While basic familiarity with Javascript and Ember _is_ recommended, our mission is to make fullstack development straightforward, painless, and productive.
10+
11+
Consider yourself a backend whiz? Authmaker lets you develop your APIs faster, without sacrificing customization. Focus on building your app's unique functionality and features, not boilerplate config and security standards.
12+
13+
We believe that you shouldn't need to be a security expert in order to build secure web apps. Authmaker lets you focus on **your application**, not authentication. Authmaker's opinionated curriculum provides you with a fullstack solution that _works_ - no messy configuration, no treacherous learning curve.
14+
15+
## The Authmaker curriculum
16+
17+
Authmaker was designed as part of a fullstack curriculum meant to help you build and deploy apps faster.
18+
19+
- **[Ember.js](https://emberjs.com/)** _(frontend)_
20+
- **[Node.js](https://nodejs.org/en/) & [Express.js](https://expressjs.com/)** _(backend)_
21+
- **[MongoDB](https://docs.mongodb.com/)** _(database)_
22+
- **Authmaker** _(authentication)_

getting-started/prerequisites.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Prerequisites
33
---
44

5+
Before you start building with Authmaker, make sure you have the following packages installed on your computer:
6+
57
#### Ember.js
68

79
Authmaker is built to work with [Ember.js](https://emberjs.com) applications. These guides will show you how to take an existing Ember application and use Authmaker to easily implement authentication and build your backend server and database. Authmaker is meant to be beginner friendly, but assumes a working knowledge of building with Ember and Javascript. The Ember [guides](https://guides.emberjs.com) are a fantastic resource for all Ember-related questions.

index.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# Overview
1+
---
2+
title: Guides
3+
---
24

3-
Placeholder for general overview of Authmaker, what it does, etc. TODO: Explain the general overview of Authmaker.
5+
Welcome to the Authmaker Guides! Start here if you're new to Authmaker and want to learn more.
6+
7+
## What is Authmaker?
8+
9+
Authmaker is a platform that helps you to build authenticated backend applications that work seamlessly with Ember.
10+
11+
## The guides
12+
13+
These guides are meant to be a practical introduction to the core concepts of Authmaker. We will cover the Authmaker workflow step by step, from initial development to deployment. Each section builds on the previous, so newcomers should start here and work their way down the table of contents.
14+
15+
Let's get started!

pages.yml

+5-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
url: "index"
33
skip_toc: true
44
pages:
5-
- title: "Authmaker Beginner Guides"
5+
- title: "Guides"
66
url: ""
77

88
- title: "Getting Started"
@@ -74,11 +74,7 @@
7474
- title: "Deployment"
7575
url: "deployment"
7676
pages:
77-
- title: "Production database"
78-
url: ""
79-
- title: "TBD"
80-
url: ""
81-
- title: "TBD"
82-
url: ""
83-
- title: "Etc"
84-
url: ""
77+
- title: "Production Databases"
78+
url: "production-databases.md"
79+
- title: "Deploying with Google Cloud"
80+
url: "gcloud-deploy.md"

payment/paid-accounts.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Paid Accounts
3+
---
4+
5+
_Documentation coming soon!_

payment/plans.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Plans & Subscriptions
3+
---
4+
5+
_Documentation coming soon!_

third-party/facebook.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Facebook
3+
---
4+
5+
_Documentation coming soon!_

third-party/freeagent.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: FreeAgent
3+
---
4+
5+
_Documentation coming soon!_

0 commit comments

Comments
 (0)