Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Content #19

Merged
merged 12 commits into from
Feb 1, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/footer.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="container pt-4">
<center class="top clearfix">
<a href="https://github.com/CradlePHP/Cradle">GitHub</a>
<a href="/docs/installation.html">Documentation</a>
<a href="/docs/1.1.-Installation.html">Documentation</a>
</center>
<div class="masthead">
<center class="copy">
2 changes: 1 addition & 1 deletion _includes/header.html
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<ul class="navbar-nav mr-auto mt-2 mt-lg-0"></ul>
<ul class="navbar-nav my-2 my-lg-0">
<li class="nav-item">
<a class="nav-link" href="/docs/installation.html">
<a class="nav-link" href="/docs/1.1.-Installation.html">
Documentation
</a>
</li>
228 changes: 140 additions & 88 deletions _includes/menu.html
Original file line number Diff line number Diff line change
@@ -1,141 +1,193 @@
<nav class="nav flex-column">
<h5>Getting Started</h5>
<a class="nav-link" href="/docs/installation.html">
Installation
<h5>1. Getting Started</h5>
<a class="nav-link" href="/wiki/1.1.-Installation.html">
1.1. Installation
</a>
<a class="nav-link" href="/docs/system/create-schema.html">
Creating a Schema

<h5>2. Working the Admin</h5>
<a class="nav-link" href="/wiki/2.1.-Creating-a-Schema.html">
2.1. Creating a Schema
</a>
<a class="nav-link" href="/docs/system/field-types.html">
Field Types
<a class="nav-link" href="/wiki/2.2.-Populating-Models.html">
2.2. Populating Models
</a>
<a class="nav-link" href="/docs/system/validation-types.html">
Validation Types
<a class="nav-link" href="/wiki/2.3.-Working-With-Relations.html">
2.3. Working With Relations
</a>
<a class="nav-link" href="/docs/system/format-types.html">
Format Types
<a class="nav-link" href="/wiki/2.4.-Adding-Menu-Items.html">
2.4. Adding Menu Items
</a>
<a class="nav-link" href="/docs/system/indexes-relations.html">
Indexes
<a class="nav-link" href="/wiki/2.5.-Roles-&-Permissions.html">
2.5. Roles &amp; Permissions
</a>
<a class="nav-link" href="/docs/development.html">
Development
<a class="nav-link" href="/wiki/2.6.-Creating-a-Fieldset.html">
2.6. Creating a Fieldset
</a>

<h5>Framework</h5>
<a class="nav-link" href="/docs/framework/introduction.html">
Introduction
<a class="nav-link" href="/wiki/2.7.-Monitoring-Changes.html">
2.7. Monitoring Changes
</a>
<a class="nav-link" href="/docs/framework/structure.html">
File Structure
<a class="nav-link" href="/wiki/2.8.-Setting-up-the-API.html">
2.8. Setting up the API
</a>
<a class="nav-link" href="/docs/framework/packages.html">
Packages
<a class="nav-link" href="/wiki/2.A.-Reference-Field-Types.html">
2.A. Reference: Field Types
</a>
<a class="nav-link" href="/docs/framework/helpers.html">
Helpers
<a class="nav-link" href="/wiki/2.B.-Reference-Validation-Types.html">
2.B. Reference: Validation Types
</a>
<!--
<a class="nav-link" href="/docs/framework/system.html">
System
<a class="nav-link" href="/wiki/2.C.-Reference-Format-Types.html">
2.C. Reference: Format Types
</a>
<a class="nav-link" href="/docs/framework/authentication.html">
Authentication
<a class="nav-link" href="/wiki/2.D.-Reference-Indexes-&-Relations.html">
2.D. Reference: Indexes &amp; Relations
</a>
<a class="nav-link" href="/docs/framework/roles.html">
Roles and Permissions

<h5>3. Server Operations</h5>
<a class="nav-link" href="/wiki/3.1.-Services-&-Settings.html">
3.1. Services &amp; Settings
</a>
<a class="nav-link" href="/docs/framework/history.html">
History Logs
<a class="nav-link" href="/wiki/3.2.-Setting-up-the-Email.html">
3.2. Setting up the Email
</a>
<a class="nav-link" href="/docs/framework/rest.html">
REST
<a class="nav-link" href="/wiki/3.3.-Setting-up-the-Queue.html">
3.3. Setting up the Queue
</a>
-->
<a class="nav-link" href="/docs/framework/developer.html">
Developer Tools
<a class="nav-link" href="/wiki/3.4.-Working-with-Files.html">
3.4. Working with Files
</a>
<a class="nav-link" href="/wiki/3.5.-Setting-up-the-Cache.html">
3.5. Setting up the Cache
</a>
<a class="nav-link" href="/docs/framework/tests.html">
Writing Tests
<a class="nav-link" href="/wiki/3.6.-Setting-up-the-Index.html">
3.6. Setting up the Index
</a>
<a class="nav-link" href="/docs/framework/server.html">
Deploying Project
<a class="nav-link" href="/wiki/3.7.-Setting-up-Docker.html">
3.7. Setting up Docker
</a>
<a class="nav-link" href="/wiki/3.8.-Deploying-a-Project.html">
3.8. Deploying a Project
</a>
<a class="nav-link" href="/wiki/3.A.-Reference-Cradle-on-Shared-Hosts.html">
3.A. Reference: Cradle on Shared Hosts
</a>
<a class="nav-link" href="/wiki/3.B.-Reference-Command-Line-Tools.html">
3.B. Reference: Command Line Tools
</a>
<a class="nav-link" href="/wiki/3.C.-Reference-Architecture-Recommendations.html">
3.C. Reference: Architecture Recommendations
</a>

<h5>Concepts</h5>
<a class="nav-link" href="/docs/concepts/introduction.html">
Introduction
<h5>4. Developing</h5>
<a class="nav-link" href="/wiki/4.1.-Developing-the-Front-End.html">
4.1. Developing the Front End
</a>
<a class="nav-link" href="/wiki/4.2.-Writing-a-Package.html">
4.2. Writing a Package
</a>
<a class="nav-link" href="/wiki/4.3.-Intro-to-Storm-ORM.html">
4.3. Intro to Storm ORM
</a>
<a class="nav-link" href="/docs/concepts/events.html">
Events
<a class="nav-link" href="/wiki/4.4.-Intro-to-Handlebars-Templating.html">
4.4. Intro to Handlebars Templating
</a>
<a class="nav-link" href="/docs/concepts/routing.html">
Routing
<a class="nav-link" href="/wiki/4.5.-Intro-to-Doon-&-Acquire.html">
4.5. Intro to Doon & Acquire
</a>
<!--
<a class="nav-link" href="/wiki/4.6.-i18n-&-l10n.html">
4.6. i18n &amp; l10n
</a>
<a class="nav-link" href="/wiki/4.7.-Pre-&-Post-Processors.html">
4.7. Pre &amp; Post Processors
</a>
<a class="nav-link" href="/wiki/4.8.-Cradle-as-a-Command-Line.html">
4.8. Cradle as a Command Line
</a>
<a class="nav-link" href="/wiki/4.9.-Writing-Tests.html">
4.9. Writing Tests
</a>
-->
<a class="nav-link" href="/wiki/4.A.-Reference-Events.html">
4.A. Reference: Events
</a>
<a class="nav-link" href="/wiki/4.B.-Reference-Handlebars-Helpers.html">
4.B. Reference: Handlebars Helpers
</a>
<a class="nav-link" href="/wiki/4.C.-Reference-Doon-Interfaces.html">
4.C. Reference: Doon Interfaces
</a>
<a class="nav-link" href="/wiki/4.D.-Reference-Global-Package-Methods.html">
4.D. Reference: Global Package Methods
</a>

<h5>5. Concepts</h5>
<a class="nav-link" href="/wiki/5.1.-Events.html">
5.1. Events
</a>
<a class="nav-link" href="/docs/concepts/middleware.html">
Middleware
<a class="nav-link" href="/wiki/5.2.-Routing.html">
5.2. Routing
</a>
<a class="nav-link" href="/docs/concepts/request.html">
Request
<a class="nav-link" href="/wiki/5.3.-Middleware.html">
5.3. Middleware
</a>
<a class="nav-link" href="/docs/concepts/response.html">
Response
<a class="nav-link" href="/wiki/5.4.-Request.html">
5.4. Request
</a>
<a class="nav-link" href="/docs/concepts/model.html">
Model
<a class="nav-link" href="/wiki/5.5.-Response.html">
5.5. Response
</a>
<a class="nav-link" href="/docs/concepts/collection.html">
Collection
<a class="nav-link" href="/wiki/5.6.-Model.html">
5.6. Model
</a>
<a class="nav-link" href="/docs/concepts/registry.html">
Registry
<a class="nav-link" href="/wiki/5.7.-Collection.html">
5.7. Collection
</a>
<a class="nav-link" href="/docs/concepts/packages.html">
Writing a Package
<a class="nav-link" href="/wiki/5.8.-Registry.html">
5.8. Registry
</a>

<h5>Traits</h5>
<a class="nav-link" href="/docs/traits/data.html">
Data Traits
<h5>6. Traits</h5>
<a class="nav-link" href="/wiki/6.1.-Data-Traits.html">
6.1. Data Traits
</a>
<a class="nav-link" href="/docs/traits/helper.html">
Helper Traits
<a class="nav-link" href="/wiki/6.2.-Helper-Traits.html">
6.2. Helper Traits
</a>
<a class="nav-link" href="/docs/traits/profiler.html">
Profiler Traits
<a class="nav-link" href="/wiki/6.3.-Profiler-Traits.html">
6.3. Profiler Traits
</a>
<a class="nav-link" href="/docs/traits/resolver.html">
Resolver Traits
<a class="nav-link" href="/wiki/6.4.-Resolver-Traits.html">
6.4. Resolver Traits
</a>

<h5>Extras</h5>
<a class="nav-link" href="/docs/extras/handlebars.html">
Handlebars
<h5>7. Extras</h5>
<a class="nav-link" href="/wiki/7.1.-Storm-ORM.html">
7.1. Storm ORM
</a>
<a class="nav-link" href="/docs/extras/storm.html">
Storm
<a class="nav-link" href="/wiki/7.2.-Handlebars-Template-Engine.html">
7.2. Handlebars Template Engine
</a>
<a class="nav-link" href="/docs/extras/curl.html">
cURL
<a class="nav-link" href="/wiki/7.3.-cURL.html">
7.3. cURL
</a>
<a class="nav-link" href="/docs/extras/i18n.html">
i18n
<a class="nav-link" href="/wiki/7.4.-Image.html">
7.4. Image
</a>
<a class="nav-link" href="/docs/extras/image.html">
Image
<a class="nav-link" href="/wiki/7.A.-Reference-i18n.html">
7.A. Reference: i18n
</a>

<h5>Notes</h5>
<a class="nav-link" href="/docs/notes/changelog.html">
<a class="nav-link" href="/wiki/changelog.html">
Changelog
</a>
<a class="nav-link" href="/docs/notes/upgrading.html">
<a class="nav-link" href="/wiki/upgrading.html">
Upgrading
</a>
<a class="nav-link" href="/docs/notes/contributing.html">
<a class="nav-link" href="/wiki/contributing.html">
Contributing
</a>
<a class="nav-link" href="/docs/notes/license.html">
<a class="nav-link" href="/wiki/license.html">
MIT License
</a>
</nav>
10 changes: 6 additions & 4 deletions _layouts/documentation.html
Original file line number Diff line number Diff line change
@@ -35,15 +35,16 @@
<header class="head" data-do="fixed-scroll">{% include header.html %}</header>

<section class="body row">
<aside class="col-lg-2 col-md-3 left">
<aside class="col-lg-3 col-md-4 left">
{% include menu.html %}
</aside>
<section class="col-lg-10 col-md-9 main">
<section class="col-lg-9 col-md-8 main">
<section class="row">
<main class="col-lg-7 col-md-7 middle">
<main class="col-lg-6 col-md-7 middle">
{{ content }}
</main>
<aside class="col-lg-3 col-md-5 right">
{% if page.menu %}
<aside class="col-lg-4 col-md-5 right">
<div class="box">
<div class="box-head box-default">
<h5 class="box-title">{{ page.menu_title }}</h5>
@@ -57,6 +58,7 @@ <h5 class="box-title">{{ page.menu_title }}</h5>
</div>
</div>
</aside>
{% endif %}
</section>
</section>
</section>
27 changes: 14 additions & 13 deletions docs/installation.md → docs/1.1.-Installation.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
layout: documentation
class: page-docs page-docs-install
class: page-docs
title: "Installation - Documentation - Cradle"
description: "Installing the full stack version of Cradle"
menu_title: Installation
menu:
requirements: Server Requirements
process: Process
load: Load the Page
requirements: 1.1.1. Server Requirements
process: 1.1.2. Process
load: 1.1.3. Load the Page
---
# Installation
# 1.1. Installation

- [1.1.1. Server Requirements](#requirements)
- [1.1.2. Installation](#installation)
- [1.1.3. Load the Page](#load)

Welcome to **Cradle!** A feature rich, modern admin builder. The following
instructions will guide you through the installation process.

- [Server Requirements](#requirements)
- [Installation](#installation)
- [Load the Page](#load)

<a name="requirements"></a>

## Server Requirements
## 1.1.1. Server Requirements

The following are needed in order to successfully install Cradle. Please make
sure your sever meets the following requirements.
@@ -41,7 +41,7 @@ the following.
- [AWS S3 SDK](https://packagist.org/packages/aws/aws-sdk-php)

<a name="process"></a>
## Process
## 1.1.2. Process

Issue the Composer create-project command in your terminal:

@@ -67,12 +67,13 @@ Optionally, you can configure your application's document / web root to the
public directory.

<a name="load"></a>
## Load the Page
## 1.1.3. Load the Page

Open your browser to `http://127.0.0.1:8888` and you should see the application
running.

### Admin
### 1.1.3.1. Admin

A default admin login is also generated with the following credentials.
- Email: `john@doe.com`
- Password: `123`
Loading
Oops, something went wrong.