Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.46 KB

README.md

File metadata and controls

32 lines (22 loc) · 1.46 KB

Polaris Project Template

This project contains the minimum boilerplate code needed to run an anchor using django-polaris version 2.

Installation

  • Fork this repository
  • Rename the repository by going to the forked repository's settings tab
  • git clone https://github.com/<YOUR USERNAME>/<RENAMED PROJECT>.git
  • Install Python 3.7
  • cd <RENAMED PROJECT>
  • Run pip install pipenv && pipenv install

Required Customizations

  • Copy the environment file cp anchor/.env-template anchor/.env
  • Add the Django and Polaris environment variables required:
  • Implement and register your custom integration functions and classes
    • From the docs homepage, select the SEPs you'd like to support to see the available integration functions and classes
    • Register your implemented integrations
  • If running a SEP-24 or SEP-6 anchor, uncomment the associated services in docker-compose.yml

Using Docker

You can use Docker and docker-compose for local development:

  • docker-compose build
  • docker-compose up