wassname/talk
1
0
Fork 0
mirror of https://github.com/wassname/talk.git synced 2026-07-15 11:26:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Spell checks + doc updates

Browse Source
This commit is contained in:
Wyatt Johnson
2017-04-14 10:26:06 -06:00
parent 7aa262e97f
commit 061e775227
2 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
INSTALL.md
+6 -6
View File
@@ -11,14 +11,14 @@
## Installation From Docker
We currently support packaging the Talk application via Docker, which automates
the dependancy install and asset build process.
the dependency install and asset build process.
Available as [coralproject/talk](https://hub.docker.com/r/coralproject/talk/) on Docker Hub.
Images are tagged using the following notation:
- `x` (where `x` is the major version number): any minor or patch updates will be included in this. If you're ok getting
new features occationally and all the bug fixes, this is the tag for you.
new features occasionally and all the bug fixes, this is the tag for you.
- `x.y` (where `y` is the minor version number): any patch updates will be
included with this tag. If you like getting fixes and having features change
only when you want, this is the tag for you. **(recommended)**
@@ -85,7 +85,7 @@ for [Docker Links](https://docs.docker.com/compose/networking/#links).
If you are interested in splitting apart services, you can simply adjust the
command being executed in the container to optimize for your use case. An
example would be if you wanted to run the API server and the job processor
on different machines. You can acheive this easily with docker compose:
on different machines. You can achieve this easily with docker compose:
```yaml
version: '2'
@@ -132,7 +132,7 @@ volumes:
```
Note that the only difference is in the `command` key. From this, you are able
to discretly control which modules are running in order to have the maximum
to discretely control which modules are running in order to have the maximum
flexibility when managing your application.
### Running
@@ -178,7 +178,7 @@ git clone https://github.com/coralproject/talk.git
#### Setup
We now have to install the dependancies and build the static assets.
We now have to install the dependencies and build the static assets.
```bash
# Install package dependancies
@@ -189,7 +189,7 @@ yarn build
```
After you create/modify the `plugins.json` (refer to `PLUGINS.md` for plugin
docs) file, you can re-run the following to install their dependancies:
docs) file, you can re-run the following to install their dependencies:
```bash
# Reconcile plugins
PLUGINS.md
+11 -5
View File
@@ -46,14 +46,20 @@ External plugins can be resolved by running:
./bin/cli plugins reconcile
```
This will also traverse into local plugin folders and install their
dependancies. _Note that if the plugin is already installed and available in the
node_modules folder, it will not be fetched again unless there is a version
mismatch._
This achieves two things:
1. It will traverse into local plugin folders and install their dependencies.
_Note that if the plugin is already installed and available in the node_modules folder, it will not be
fetched again unless there is a version mismatch._ This will result in the
project `package.json` and `yarn.lock` files to be modified, this is normal as
this ensures that repeated deployments (with the same config) will have the
same config, these changes should not be committed to source control.
2. It will seek out dependencies that are listed in the object notation and try
to install them from npm.
## Plugin Dependencies
You may also include additional external depenancies in your local packages by
You may also include additional external dependencies in your local packages by
specifying a `package.json` at your plugin root which will result in a
`node_modules` folder being generated at the plugin root with your specific
dependencies.