mirror of
https://github.com/oceanprotocol/barge.git
synced 2024-12-01 13:37:17 +01:00
78 lines
2.4 KiB
Markdown
78 lines
2.4 KiB
Markdown
[](https://oceanprotocol.com)
|
|
|
|
<h1 align="center">docker-images</h1>
|
|
|
|
> 💧 Ocean Protocol & Docker
|
|
> [oceanprotocol.com](https://oceanprotocol.com)
|
|
|
|
Docker compose and tools running the complete Ocean Protocol stack
|
|
|
|
## Table of Contents
|
|
|
|
- [Get Started](#get-started)
|
|
- [Docker](#docker)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
|
|
---
|
|
|
|
## Get Started
|
|
|
|
For local development you can use Docker & Docker Compose. To do that you need to have the newest versions available of both:
|
|
|
|
* [Docker](https://www.docker.com/get-started)
|
|
* [Docker Compose](https://docs.docker.com/compose/)
|
|
|
|
### Docker
|
|
|
|
The most simple way to get started is with Docker compose:
|
|
|
|
```bash
|
|
docker-compose --project-name=ocean up
|
|
```
|
|
|
|
This will give you a local instance of Ocean Protocol.
|
|
|
|
After having everything running, you could open the browser and access to the **pleuston frontend** application:
|
|
|
|
```
|
|
http://localhost:3000
|
|
```
|
|
|
|
## Ocean components
|
|
|
|
The Ocean Docker compose starts the following components:
|
|
|
|
* **Pleuston** frontend application. Listening the **3000** port.
|
|
* **Provider backend**. Listening the **5000** port.
|
|
* **Keeper contracts**. Listening the **8545** port.
|
|
* **BigchainDB**. Listening the **9984** port.
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
We use GitHub as a means for maintaining and tracking issues and source code development.
|
|
|
|
If you would like to contribute, please fork this repository, do work in a feature branch, and finally open a pull request for maintainers to review your changes.
|
|
|
|
Ocean Protocol uses [C4 Standard process](https://github.com/unprotocols/rfc/blob/master/1/README.md) to manage changes in the source code. Find here more details about [Ocean C4 OEP](https://github.com/oceanprotocol/OEPs/tree/master/1).
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright 2018 Ocean Protocol Foundation
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
```
|