Skip to content

Latest commit

 

History

History
59 lines (28 loc) · 1.95 KB

README.md

File metadata and controls

59 lines (28 loc) · 1.95 KB
Raw

Pangea Network Admin Dashboard

To run this app:

  1. Clone the repository:

    git clone https://github.com/elixirlabsinc/pangeanetwork.git

    cd pangeanetwork

Backend setup

  1. Create and activate a virtual environment:

    virtualenv env -p python3

    source env/bin/activate

  2. Install requirements:

    pip install -r 'requirements.txt'

  3. Run the application:

    python3 app.py

    The backend will run at localhost:5000. The first time you run this example, a sample sqlite database gets populated automatically. To suppress this behaviour, comment the following lines in app.py:

     if not os.path.exists(database_path):
     build_sample_db()

Frontend setup

  1. In a new tab, navigate to pangeanetwork/web directory

  2. Run npm start

  3. View the UI at localhost:3000

Testing with Africa's Talking API

  1. Install ngrok

  2. With backend server running, run ./ngrok http 5000 in a new tab

  3. From your Africa's Talking account, navigate to SMS > SMS Callback URLs > Incoming Messages and fill in the forwarding url from ngrok in the URL form.

  4. From your Africa's Talking account, navigate to Settings > API Key to generate an API Key. Store this in your local environment variables as AT_API_KEY.

  5. Open the Sandbox by clicking on Launch Simulator from your Africa's Talking account and there you can test sending/receiving SMS messages to/from your local running instance of the app.

Contributing

If you see an open issue you want to work on, either assign it to yourself or comment that you are starting to work on it. Check out a new branch from master with the ticket number and a brief description of the ticket such as [ticket number]_add_transactions_endpoint. Once you have finished your changes, push them to your remote branch and open up a Merge Request back to the master branch.