mirror of
https://github.com/fullstack-cash/explorer.fullstack.cash.git
synced 2026-09-21 16:52:05 -07:00
Merge pull request #4 from Permissionless-Software-Foundation/ct-unstable
Updating README
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2018 gatsbyjs
|
Copyright (c) 2020 Permissionless Software Foundation
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@@ -5,22 +5,20 @@
|
|||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
<h1 align="center">
|
<h1 align="center">
|
||||||
Gatsby's hello-world starter
|
A BCH Web Wallet Gatsby Starter
|
||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
Kick off your project with this hello-world boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
|
Create your own Bitcoin Cash web wallet app with this Gatsby Starter. This Starter leverages the [gatsby-ipfs-web-wallet Gatsby Theme](https://github.com/Permissionless-Software-Foundation/gatsby-ipfs-web-wallet) by [FullStack.cash](https://fullstack.cash). Additional plugins can be developed with the [bch-wallet-plugin-boilerplate](https://github.com/Permissionless-Software-Foundation/bch-wallet-plugin-boilerplate).
|
||||||
|
|
||||||
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
|
|
||||||
|
|
||||||
## 🚀 Quick start
|
## 🚀 Quick start
|
||||||
|
|
||||||
1. **Create a Gatsby site.**
|
1. **Create a Gatsby site.**
|
||||||
|
|
||||||
Use the Gatsby CLI to create a new site, specifying the hello-world starter.
|
Use the Gatsby CLI to create a new site, specifying this starter.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# create a new Gatsby site using the hello-world starter
|
# create a new Gatsby site using this starter
|
||||||
gatsby new my-hello-world-starter https://github.com/gatsbyjs/gatsby-starter-hello-world
|
gatsby new my-bch-wallet-app https://github.com/Permissionless-Software-Foundation/bch-wallet-starter
|
||||||
```
|
```
|
||||||
|
|
||||||
1. **Start developing.**
|
1. **Start developing.**
|
||||||
@@ -28,7 +26,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti
|
|||||||
Navigate into your new site’s directory and start it up.
|
Navigate into your new site’s directory and start it up.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
cd my-hello-world-starter/
|
cd my-bch-wallet-app/
|
||||||
gatsby develop
|
gatsby develop
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -38,7 +36,7 @@ _Have another more specific idea? You may want to check out our vibrant collecti
|
|||||||
|
|
||||||
_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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
|
_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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
|
||||||
|
|
||||||
Open the `my-hello-world-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
|
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?
|
## 🧐 What's inside?
|
||||||
|
|
||||||
@@ -47,6 +45,9 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
|
|||||||
.
|
.
|
||||||
├── node_modules
|
├── node_modules
|
||||||
├── src
|
├── src
|
||||||
|
└── gatsby-ipfs-web-wallet
|
||||||
|
└── components
|
||||||
|
└── menu-components.js
|
||||||
├── .gitignore
|
├── .gitignore
|
||||||
├── .prettierrc
|
├── .prettierrc
|
||||||
├── gatsby-browser.js
|
├── gatsby-browser.js
|
||||||
@@ -82,6 +83,11 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
|
|||||||
|
|
||||||
12. **`README.md`**: A text file containing useful reference information about your project.
|
12. **`README.md`**: A text file containing useful reference information about your project.
|
||||||
|
|
||||||
|
12. **`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](https://fullstack.cash). Our [quick-start example code](https://fullstack.cash/examples) and video tutorials will get you started quickly. The [Documentation page](https://fullstack.cash/documentation) has all the educational material you'll need.
|
||||||
|
|
||||||
## 🎓 Learning Gatsby
|
## 🎓 Learning Gatsby
|
||||||
|
|
||||||
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
|
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
|
||||||
|
|||||||
@@ -3,6 +3,11 @@
|
|||||||
"description": "A BCH web wallet starter for Gatsby.",
|
"description": "A BCH web wallet starter for Gatsby.",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
"author": "Chris Troutner <chris.troutner@gmail.com>",
|
||||||
|
"contributors": [
|
||||||
|
"Daniel Gonzalez <danielhumgon@gmail.com>",
|
||||||
|
"Andre Cabrera <andrecabrera@protonmail.ch>"
|
||||||
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "gatsby build",
|
"build": "gatsby build",
|
||||||
"develop": "gatsby develop",
|
"develop": "gatsby develop",
|
||||||
|
|||||||
Reference in New Issue
Block a user