Skip to content
This repository was archived by the owner on Jun 2, 2026. It is now read-only.
This repository was archived by the owner on Jun 2, 2026. It is now read-only.

Improvements for local development #75

Open

Description

@RafaelVidaurre

To avoid getting our devs stuck on some problem in our local environment, we still have to do some extra work to make sure we help them avoid common issues.

The rule should be: "A developer without previous knowledge about our code must be able to test, build and run apps and scripts without any help".

This is a list of things I believe we need to achieve this (feel free to add more):

  • Environment variables should be checked on startup: Any environment variable required by a package has to be pre-checked on startup, providing a helpful error if they are not set.
  • A place to retrieve secrets for our team members: Lastpass would be a good place for this, this is where PAI keys and other private values should be available for our team members
  • Setup instructions for all services needed to run our apps: Anything that needs to be installed before running our code should be explained in our README.md file. (Things like mongodb, yarn or nvm for example)
  • When possible, errors should give instructions to fix the issue: Instead of receiving Contract not deployed to network 42 we should get something like Smart contracts were not detected in the network you are trying to connect, you should run "local-blockchain:generate: to fix this issue

Activity

  1. Grsmto commented on Oct 16, 2018

    @Grsmto
    Contributor
    • Local blockchain should provide different state: We should provide different app state for the local blockchain so a dev can rapidly test different scenarios (before, after STO created, etc.).
  2. monitz87 commented on Oct 18, 2018

    @monitz87
    Contributor
    • Apps should throw errors and exit when not able to establish initial connections: This includes (but is not restricted to) mongodb, web3 and sendgrid
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions