Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hxtree committed Jun 28, 2020
1 parent 49e469a commit 6785bef
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 7 deletions.
48 changes: 48 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
env:
# You may want to update this to whatever the latest version is, or keep it
# the same as your local machines. However, I have only tested it with 1.8.0+.
# There should be a time in the future when this is not necessary - it is
# explained in more detail below.
DOCKER_COMPOSE_VERSION: 1.8.0

before_install:
# update is required to update the repositories to see the new packages for
# Docker.
- sudo apt-get update
# Now we can install the newer docker-engine which is required for the newer
# docker-composer we will install next. The messy options are to force it to
# be non-interactive (normally it asks you a bunch of config questions).
- sudo apt-get install -o Dpkg::Options::="--force-confold" --force-yes -y docker-engine

# Print out the current docker-compose version. Once this reports 1.6+ then we
# do not need the following steps.
- docker-compose --version

# As of the writing of this script Travis has docker-compose v1.4.2, we need
# to update it to 1.8+. $DOCKER_COMPOSE_VERSION is provide from the `env`
# above.
- sudo rm /usr/local/bin/docker-compose
- curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
- chmod +x docker-compose
- sudo mv docker-compose /usr/local/bin

# Check that docker-compose is now running the latest version (or at least the
# one we specified). This is not to be confused with the version we printed
# before doing the update.
- docker-compose --version

# Setup your application stack. You may need to tweak these commands if you
# doing out-of-the-ordinary docker-compose builds.
- docker-compose pull
- docker-compose build
- docker-compose start

# You will want this for logging. If one of your containers does not build for
# whatever reason it's best to report that now before your tests start
# otherwise it can be really tricky to debug why tests are failing sometimes.
- docker ps

# This is just our script to setup all the database tables and other fixtures
# we need. You should remove this if it's not necessary or you have other
# scripts handling this.
- docker/web/provision.sh
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,41 @@
# Hoopless
<p align="center"><h1>Hoopless</h1></p>

<p align="center">
<a href="https://packagist.org/packages/ouxsoft/hoopless"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ouxsoft/hoopless"></a> <a href="https://travis-ci.com/github/ouxsoft/hoopless"><img src="https://api.travis-ci.com/ouxsoft/hoopless.svg?branch=master&status=passed" alt="Build Status"></a> <a href="https://app.codacy.com/gh/ouxsoft/hoopless?utm_source=github.com&utm_medium=referral&utm_content=ouxsoft/hoopless&utm_campaign=Badge_Grade_Dashboard"><img alt="Codacy grade" src="https://img.shields.io/codacy/grade/86210d48e2ca45e497be865ace8a4029"></a> <a href="https://codecov.io/gh/ouxsoft/hoopless"> <img alt="Codecov" src="https://img.shields.io/codecov/c/github/ouxsoft/hoopless"> </a> <a href="https://packagist.org/packages/ouxsoft/hoopless"><img src="https://poser.pugx.org/ouxsoft/hoopless/downloads" alt="Total Downloads"></a>
</p>


## About
A modular content management system in PHP.

## Usage
## Installation

### Via Composer
Hoopless is available on [Packagist](https://packagist.org/packages/ouxsoft/hoopless).

Install with [Composer](https://getcomposer.org/download/):
```shell script
composer require ouxsoft/hoopless
```

### Via Git
Install with [Git](https://git-scm.com/):
```shell script
git clone git@github.com:ouxsoft/Hoopless.git
```

## Usage

### Via Docker
Start with [Docker](https://docs.docker.com/get-docker/)
```shell script
sudo ./docker.sh start dev
```

View in browser [https://localhost](https://localhost)
View in browser [https://localhost](https://localhost)

## Creators

***Matthew Heroux***

* [https://github.com/hxtree](https://github.com/hxtree)
8 changes: 4 additions & 4 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6785bef

Please sign in to comment.