https://github.com/concretecms/build-book
A git repository for the Building a Website with concrete5 Book.
https://github.com/concretecms/build-book
Last synced: about 1 year ago
JSON representation
A git repository for the Building a Website with concrete5 Book.
- Host: GitHub
- URL: https://github.com/concretecms/build-book
- Owner: concretecms
- License: mit
- Created: 2019-09-04T20:53:37.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T22:03:02.000Z (over 3 years ago)
- Last Synced: 2025-06-06T18:53:05.252Z (about 1 year ago)
- Language: JavaScript
- Size: 23.3 MB
- Stars: 0
- Watchers: 6
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Composer Based Skeleton for concrete5 sites
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.txt)
[![Build Status][ico-travis]][link-travis]
[![Total Downloads][ico-downloads]][link-downloads]
## Creating a new project
First choose a name for your project. In this example, our project is called "the_oregon_trail"
```bash
$ composer create-project -n concrete5/composer the_oregon_trail
```
Now you have the latest version of concrete5 and you're ready to install!
Note: This is a skeleton project. So once you create a project, you can install your own VCS and change the README and all that.
## Starting with the concrete5 latest develop
First create a new project
```bash
$ composer create-project -n concrete5/composer the_oregon_trail
```
Then navigate into that project and require the `dev-develop` version of `concrete5/core`
```bash
$ cd the_oregon_trail
$ composer require concrete5/core:dev-develop
```
## Installing concrete5
Navigate into your new concrete5 project
```bash
$ cd the_oregon_trail
```
and use the interactive install commmand that comes with concrete5's CLI tool
```bash
$ ./vendor/bin/concrete5 c5:install -i
```
Follow directions and your site will begin installing!
Note: You can also run the CLI tool directly with PHP
```bash
$ ./public/concrete/bin/concrete5
```
## Install a concrete5 package using composer
Find the package you'd like to install on [packagist.org](https://packagist.org) (in this case [`concrete5/sample_composer_package`](https://packagist.org/packages/concrete5/sample_composer_package))
Note: You can also use composer's repository functionality to manage private packages using composer
```bash
$ composer require concrete5/sample_composer_package
$ ./vendor/bin/concrete5 c5:package-install sample_composer_package
```
## Compiling JS / CSS assets
This library uses [Laravel Mix][link-mix]. See [webpack.mix.js][link-webpack-mix-file].
Using Yarn run (If you're using NPM instead, just swap `yarn` for `npm`.):
```
yarn install
yarn dev
```
To compile assets for development.
Do you want to install an add-on that is free in the concrete5 marketplace, but not on packagist.org? Go to https://composer.concrete5.org.
[ico-version]: https://img.shields.io/packagist/v/concrete5/composer.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/concrete5/composer/master.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/concrete5/composer.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/concrete5/composer
[link-travis]: https://travis-ci.org/concrete5/composer
[link-downloads]: https://packagist.org/packages/concrete5/composer
[link-mix]: https://laravel.com/docs/5.5/mix
[link-webpack-mix-file]: ./webpack.mix.js