From 2bada95c2ac79245a373d72385707f9aac041e34 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Fri, 6 Aug 2021 11:54:56 -0700 Subject: [PATCH] Customizing package.json and READMe --- LICENSE => LICENSE.md | 2 +- README.md | 111 ++++-------------------------------------- package.json | 8 +-- 3 files changed, 14 insertions(+), 107 deletions(-) rename LICENSE => LICENSE.md (95%) diff --git a/LICENSE b/LICENSE.md similarity index 95% rename from LICENSE rename to LICENSE.md index b161ac5..cdcc7fd 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 Permissionless Software Foundation +Copyright (c) 2021 Permissionless Software Foundation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index e1b6f64..d1aae12 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,19 @@

- + Gatsby

- A BCH Web Wallet Gatsby Starter + + Explorer.FullStack.Cash +

+

A 'block explorer' for the [pay-to-write database](https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service) (P2WDB)

-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). +This is a Gatsby web app that allows users explore the current state of the +[pay-to-write database](https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-service) (P2WDB). This site was forked from [bch-wallet-starter](https://github.com/Permissionless-Software-Foundation/bch-wallet-starter). -- Live demo of this starter: [demo-wallet.fullstack.cash](https://demo-wallet.fullstack.cash) +## License -There are several customized versions of this web wallet starter. Here are a few: -- [wallet.fullstack.cash](https://wallet.fullstack.cash) -- [message.fullstack.cash](https://message.fullstack.cash) -- [torlist.cash](https://torlist.cash) - -## πŸš€ Quick start - -1. **Create a Gatsby site.** - - Use the Gatsby CLI to create a new site, specifying this starter. - - ```shell - # create a new Gatsby site using this starter - gatsby new my-bch-wallet-app https://github.com/Permissionless-Software-Foundation/bch-wallet-starter - ``` - -1. **Start developing.** - - Navigate into your new site’s directory and start it up. - - ```shell - cd my-bch-wallet-app/ - gatsby develop - ``` - -1. **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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._ - - 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](https://prettier.io/). 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](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). - -7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/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](https://www.gatsbyjs.org/docs/ssr-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. - -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 - -Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start: - -- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. - -## πŸ’« Deploy - -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-hello-world) - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/gatsbyjs/gatsby-starter-hello-world) - - +[MIT](LICENSE.md) diff --git a/package.json b/package.json index 66bad9e..5c0d15e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "bch-wallet-starter", - "description": "A BCH web wallet starter for Gatsby.", + "name": "explorer.fullstack.cash", + "description": "A 'block explorer' for the P2WDB", "version": "1.0.0", "license": "MIT", "author": "Chris Troutner ", @@ -25,10 +25,10 @@ }, "repository": { "type": "git", - "url": "https://github.com/Permissionless-Software-Foundation/bch-wallet-starter" + "url": "https://github.com/Permissionless-Software-Foundation/explorer.fullstack.cash" }, "bugs": { - "url": "https://github.com/Permissionless-Software-Foundation/bch-wallet-starter/issues" + "url": "https://github.com/Permissionless-Software-Foundation/explorer.fullstack.cash/issues" }, "devDependencies": { "semantic-release": "^17.4.3",