Download the PHP package codymoorhouse/chronicle without Composer

On this page you can find all versions of the php package codymoorhouse/chronicle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package chronicle

Chronicle

Table Of Contents

  1. About
  2. Installation
  3. Requirements
  4. Instructions
  5. Usage
  6. Properties
  7. License

About

This package is designed for Laravel that lets users interact with eachother using notes that allow for file uploads and comments. Notes are tracked and held in sections and can have multiple files/comments attached.

Installation

Requirements

To use this package, the following requiremenst must be met:

NPM Packages

Current Front End Limitations

As the package is still being developed, not all features are currently available. For now, it is recommended you disable the features in the database by setting the booleans accordingly on the sections you are using.

Instructions

Once you have succesfully required the package, (v5.3 only) you must register the service provider in your config/app.php file.

After you have registered the package you can now publish the associated files. This will publish the config file as well as some default vue components

Before you run the migrations, you can look at the config/chronicle.php file and update the values and models as needed, or just use the defaults. Then you may run the migration command to set up all the required tables:

Usage

Back End

To use chronicle you must make a section in the database. To help set up a quick section, you can use this command:

The tag you specified will be used in the front end. You will also need a reference slug for the front end. Think of the reference slug as a 'sub-section' of a section. So basically when you create a section, you can have many notes within the section. However, notes are assigned a reference slug, and that reference slug determines which notes will be shown.

Example: You create a chronicle section with the tag 'user-notes'

Rather than making a new section for each different user, you simply set the ref-slug to be that users id, or some unique slug for that user. Now when a user looks at that section, they will only see notes with the same ref slug. (aka - their id/slug).

Front End

Register chronicle as a component in your vue instance.

Use the component anywhere in your app instance. If you do not pass in a user, chronicle will display as 'read only'.

Properties

Property Required Type Default Description
tag true String n/a The tag of the section to show
ref-slug true String n/a A ref slug for a section, only shows notes with this ref slug
load-font-awesome false Boolean true Boolean to toggle auto load of font awesome on or off
show-display false Boolean true Shows the display
show-input false Boolean true Shows the input / add note button
show-pages false Boolean true Turns off pagination in the title slot
show-title false Boolean true Turns off title in the title slot (pages will be shown instead)
use-font-awesome false Boolean true Use font awesome for buttons
user false Object new Object() A logged in user object

License

This project is covered under the MIT License. Feel free to use it wherever you like.


All versions of chronicle with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
illuminate/database Version ~5.1
illuminate/support Version ~5.1
illuminate/routing Version ~5.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package codymoorhouse/chronicle contains the following files

Loading the files please wait ....