This section describes how to build and run the platform for developers.
Here is the list of dependencies:
- make
- go (1.10+, 64bit for Windows)
- GOBIN added to your PATH (to check your GOBIN:
echo $(go env GOPATH)/bin) - curl
- yarn (1.12.3+)
- node (8.11.3+, node v12 is incompatible)
- vue-cli
- git
- docker-compose (18.06.0+)
- wget (for godoc generation)
- (OSX) Brew Package Manager
- (OSX) Command Line Tools (Xcode)
sudo apt-get install make golang curl npm git license-finder-pip
If you currently do not have the OSX Command Line Tools installed run
xcode-select --install
brew install make golang curl npm git
PATH=$PATH:$(go env GOPATH)/bin
The project uses go modules.
Clone the repository outside your GOPATH:
cd <your workspace>
git clone https://github.com/ProxeusApp/proxeus-core.git
cd proxeus-core
All the build projects are stated in ./Makefile.
Before building Proxeus, make sure to set all required environment variables.
export PROXEUS_DATA_DIR=./data
export PROXEUS_INFURA_API_KEY=<Your Infura API key>
export PROXEUS_SPARKPOST_API_KEY=<Your SparkPost API Key>
export PROXEUS_BLOCKCHAIN_CONTRACT_ADDRESS=0x1d3e5c81bf4bc60d41a8fbbb3d1bae6f03a75f71
export PROXEUS_ALLOW_HTTP=true
export PROXEUS_PLATFORM_DOMAIN=localhost
export [email protected]
Make sure that the email domain for PROXEUS_EMAIL_FROM is a configured sending domain in sparkpost
To initialize dependencies run:
make init
The make all command build the server and ui:
make all
Run server.
./artifacts/proxeus
The platform will be available at the following URL: http://localhost:1323
It is now time to configure your platform