forked from TrueCloudLab/frostfs-dev-env
68 lines
1.8 KiB
Markdown
68 lines
1.8 KiB
Markdown
<p align="center">
|
|
<img src="./.github/logo.svg" width="500px" alt="NeoFS">
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://fs.neo.org">NeoFS</a> local Development and Testing environment
|
|
</p>
|
|
|
|
---
|
|
## Overview
|
|
|
|
Tools to set up local NeoFS network and Neo 3 privnet. Devenv, for short.
|
|
|
|
## Quick Start
|
|
|
|
```
|
|
$ make up
|
|
```
|
|
|
|
You can see the addresses and hostnames of components with `make hosts` command.
|
|
|
|
```
|
|
$ make hosts
|
|
192.168.130.10 bastion.neofs.devenv
|
|
192.168.130.50 main_chain.neofs.devenv
|
|
192.168.130.61 ir01.neofs.devenv
|
|
...
|
|
192.168.130.74 s04.neofs.devenv
|
|
```
|
|
|
|
It's recommended to add `make hosts` output to your local `/etc/hosts` file.
|
|
|
|
## How it's organized
|
|
|
|
```
|
|
.
|
|
├── Makefile # Commands to manage devenv
|
|
├── .services # List of services to work with
|
|
├── services # Services definitions and files
|
|
│ ├── basenet
|
|
│ ├── chain
|
|
│ ├── ir
|
|
│ ├── morph_chain
|
|
│ └── storage
|
|
├── vendor # Temporary files and artifacts
|
|
└── wallets # Wallet files to manage GAS assets
|
|
```
|
|
|
|
Main commands and targets to manage devenv's services are in `Makefile`.
|
|
|
|
Each service is defined in it's own directory under `services/` with all
|
|
required files to run and scripts to get external artifacts or dependencies.
|
|
|
|
The list of services and the starting order is defined in `.services` file. You
|
|
can comment out services you don't want to start or add your own new services.
|
|
|
|
You can find more information on each service in `docs` directory.
|
|
|
|
## Contributing
|
|
|
|
Feel free to contribute to this project after reading the [contributing
|
|
guidelines](CONTRIBUTING.md).
|
|
|
|
Before starting to work on a certain topic, create an new issue first,
|
|
describing the feature/topic you are going to implement.
|
|
|
|
# License
|
|
|
|
- [GNU General Public License v3.0](LICENSE)
|