Getting started

Take these first steps to get going with developing an app in PillarX

The first thing we'll do is get PillarX up and running on your machine.

1. Checkout the code at https://github.com/pillarwallet/x

2. Run npm i in the root of the codebase

3. Rename .env.example to .env

4. Run npm start

   1. ⚠️ Starting for the first time? It may take longer than usual to launch, but subsequent executions will be quicker.

5. Browse to /login to sign in to PillarX

🚀 Welcome to PillarX!

Configuring PillarX

Let's take a look at the .env file which configures your running version of PillarX.

Environment Variable	Description
REACT_APP_PRIVY_APP_ID	We use Privy to onboard users who use social networking or email providers as their primary way of signing in to a product. The default value here has likely maxed out the number of users allowed to sign up. If you're not signing in with a browser wallet or WalletConnect, sign up for your own free Privy account and replace the App ID here.
REACT_APP_ETHERSPOT_BUNDLER_API_KEY	PillarX uses TransactionKit under the hood to facilitate blockchain transactions. TransactionKit uses Etherspot's bundler to send transactions and this is where the API key specified. The default API key is heavily rate limited.
REACT_APP_ETHERSPOT_DATA_API_KEY	PillarX uses TransactionKit under the hood to facilitate blockchain transactions. TransactionKit uses Etherspot's data service to read blockchain data and this is where the API key specified. The default API key is heavily rate limited.
REACT_APP_USE_TESTNETS	Either "true" or "false". Instructs PillarX to run in either testnets mode or mainnets mode.
REACT_APP_GOOGLE_ANALYTICS_MEASUREMENT_ID	Optional. Add your own Google Analytics measurement ID here. The default goes to a test account.
REACT_APP_PLAUSIBLE_DOMAIN	Optional. If you prefer Pausible, add your own domain here. The default goes to a test account.
REACT_APP_PX_DEVELOPMENT_ID	The name of the directory located in src/apps that you're building your app in. The directory name should be snake-case. If this value exists, it will be automatically loaded by PillarX and appears in the Action Bar's "Apps" drawer.