Skip to content

A Gatsby Starter that leverages the gatsby-ipfs-web-wallet Gatsby Theme for creating a BCH wallet app.

License

Notifications You must be signed in to change notification settings

dibble1/bch-wallet-starter

 
 

Repository files navigation

Gatsby

A BCH Web Wallet Gatsby Starter

Create your own Bitcoin Cash web wallet app with this Gatsby Starter. This Starter leverages the gatsby-ipfs-web-wallet Gatsby Theme by FullStack.cash. Additional plugins can be developed with the bch-wallet-plugin-boilerplate.

There are several customized versions of this web wallet starter. Here are a few:

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying this starter.

    # create a new Gatsby site using this starter
    gatsby new my-bch-wallet-app https://github.com/Permissionless-Software-Foundation/bch-wallet-starter
  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd my-bch-wallet-app/
    gatsby develop
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the my-bch-wallet-app directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
  └── gatsby-ipfs-web-wallet
    └── components
      └── menu-components.js
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  9. LICENSE: Gatsby is licensed under the MIT license.

  10. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  11. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  12. README.md: A text file containing useful reference information about your project.

  13. menu-components.js: Allows you to add new menu items and Views to the app.

🎓 Learning Bitcoin Cash

If you are new to the world of Bitcoin Cash development, head on over to FullStack.cash. Our quick-start example code and video tutorials will get you started quickly. The Documentation page has all the educational material you'll need.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

Deploy to Netlify

Deploy with Vercel

  • test 3

About

A Gatsby Starter that leverages the gatsby-ipfs-web-wallet Gatsby Theme for creating a BCH wallet app.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%