Skip to content
Merged
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ services:
- docker

script:
- docker build -t apinf/apinf:"$TRAVIS_BRANCH" .
- docker build -t apinf/platform:"$TRAVIS_BRANCH" .
- docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
- docker push apinf/apinf:"$TRAVIS_BRANCH"
- docker push apinf/platform:"$TRAVIS_BRANCH"
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ This can be accomplished by grabbing the container ID with a docker ps, then pas
```
$ docker ps
CONTAINER ID IMAGE
ce9de67fdcbe apinf/apinf:latest
ce9de67fdcbe apinf/platform:latest
$ docker exec -it ce9de67fdcbe /bin/bash
root@ce9de67fdcbe:/#
```
Expand All @@ -177,17 +177,17 @@ alias apinf_web='docker exec -it `docker ps | grep web | sed "s/ .*//"` /bin/bas
To build packages for the current APInf version:

```
$ docker build -t apinf/apinf:INSERT_VERSION_HERE .
$ docker tag apinf/apinf:INSERT_VERSION_HERE apinf/apinf:latest
$ docker build -t apinf/platform:INSERT_VERSION_HERE .
$ docker tag apinf/platform:INSERT_VERSION_HERE apinf/platform:latest
```

### Pushing to Docker Hub

To publish the new images to our [Docker Hub repository](https://hub.docker.com/r/apinf/apinf/):
To publish the new images to our [Docker Hub repository](https://hub.docker.com/r/apinf/platform/):

```
$ docker push apinf/apinf:INSERT_VERSION_HERE
$ docker push apinf/apinf:latest
$ docker push apinf/platform:INSERT_VERSION_HERE
$ docker push apinf/platform:latest
```

# Contributing code
Expand Down Expand Up @@ -220,7 +220,7 @@ In a nutshell, **write code for humans to read and understand**. Our code will b
* Placing comments on the preceeding line, as opposed to the end of the line, improves readability
* comment can be long, e.g. 80 characters
* comments at same level of nesting fall in-line with one another vertically

#### Example comment
```js
// Try and find the missing widget
Expand Down Expand Up @@ -259,7 +259,7 @@ let missingWidgets = Widgets.find().fetch();
if (missingWidgets) {
// Count the missing widgets
let missingWidgetsCount = missingWidgets.length

// Alert the boss!
console.log(missingWidgetsCount, "widgets are missing!");
}
Expand Down Expand Up @@ -307,7 +307,7 @@ Configure your IDE to use eslint with the Airbnb styleguide.
Reference: Meteor Guide - Check Your Code with ESLint [Integrating with your editor](https://guide.meteor.com/code-style.html#eslint-editor)

# File structure
This project is organized around a 'module' / 'component' architecture.
This project is organized around a 'module' / 'component' architecture.

By 'module', we mean anything that has it's own database collection and one or more routes. Components are more closely related to the idea of [WebComponents](http://webcomponents.org/), which are intended to be reusable, hierarchical user interface elements. Modules are located in the project root, with components in the client sub-directory.

Expand Down
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

1. Run API-umbrella container http://api-umbrella.readthedocs.io/en/latest/getting-started.html#running-with-docker
2. Obtaining API Key and Authentication token. You can obtain the *Authentication Token* and *API Key* from the API Umbrella platform by following instructions in the [Getting Started](http://apiumbrella.io/docs/getting-started/) and [API Umbrella Admin API](http://apiumbrella.io/docs/admin-api/) documentation.
3. Run APInf container ```docker run -p 8080:80 -e MONGO_URL=mongodb://localhost:27017/your_db -e MAIL_URL=smtp://some.mailserver.com:25 -e ROOT_URL=http://YOUR_SITE_DOMAIN apinf/apinf:latest```
3. Run APInf container ```docker run -p 8080:80 -e MONGO_URL=mongodb://localhost:27017/your_db -e MAIL_URL=smtp://some.mailserver.com:25 -e ROOT_URL=http://YOUR_SITE_DOMAIN apinf/platform:latest```
4. Configure APInf

### Configure APInf
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Docker image

[![](https://images.microbadger.com/badges/image/apinf/apinf.svg)](http://microbadger.com/images/apinf/apinf) [![](https://images.microbadger.com/badges/version/apinf/apinf.svg)](http://microbadger.com/images/apinf/apinf)
[![](https://images.microbadger.com/badges/image/apinf/platform.svg)](http://microbadger.com/images/platform/apinf) [![](https://images.microbadger.com/badges/version/apinf/platform.svg)](http://microbadger.com/images/apinf/platform)

# Links
- [Documentation](http://apinf.org/docs) - APInf documentation
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '2'
services:
apinf:
image: apinf/apinf
image: apinf/platform
restart: always
env_file:
- 'docker/apinf/env'
Expand Down