Skip to content

Commit

Permalink
Add github files and templates, update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
wbobeirne committed Dec 12, 2018
1 parent a717802 commit c9ace8c
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1 @@
Please see the [Contributor Guidelines on the Wiki](https://github.com/wbobeirne/joule-extension/wiki/Contributor-Guidelines).
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,28 @@
---
name: Bug Report
about: Something gone wrong? Tell us about it!
---

<!--
BEFORE SUBMITTING:
1) Please search to make sure this issue has not been opened already
2) If you're looking for help setting up your node, try asking in the LND Slack instead: https://dev.lightning.community/
-->

### Description of the Issue

[Your description of the bug goes here]

### Steps to Reproduce

[Explain what you did to experience the issue]

### Description of Your Setup

*Browser & version*:
*Operating system*:
*Node software & version*:

### Console Logs / Screenshots

[Please provide these if you can!]
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,16 @@
---
name: Feature Request / Idea
about: Any and all suggestions welcome
---

<!--
BEFORE SUBMITTING: Please search to make sure this hasn't already been suggested
-->

### Description of the Feature or Idea

[Your description goes here]

### Existing Example(s) of Feature

[If another product or app is doing this, please link to it]
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
<!-- New to the project? Check out the Contributor Guidelines! -->
<!-- https://github.com/wbobeirne/joule-extension/wiki/Contributor-Guidelines -->

Closes #(issue number goes here)

### Description

[Description of your changes go here. Please provide both casual and technical explanations.]

### Steps to Test

1. Steps
2. To
3. Test

### Screenshots

[Only if applicable]
41 changes: 40 additions & 1 deletion README.md
@@ -1,4 +1,8 @@
# Joule Extension for Lightning
<p align="center">
<img src="https://camo.githubusercontent.com/ff4a641fba4f90ea2a24413d8874bb464883685d/68747470733a2f2f692e696d6775722e636f6d2f595968594335652e706e67" alt="" data-canonical-src="https://i.imgur.com/YYhYC5e.png" style="max-width:100%;" width="400">
</p>

## Overview

A chrome extension that lightning-charges your browser with
[webln](https://github.com/wbobeirne/webln), giving you
Expand All @@ -7,6 +11,37 @@ the ability to pay and use your node as an identity on the web.
**WARNING: Joule is in early alpha, and should not be used for large mainnet funds**


## Project Layout

```bash
joule-extension/
├── src # All source code
│   ├── app # The main React app, used by the other clients
│   │   ├── index.tsx # Entry point for the app
│   │   ├── AppRoutes.tsx # Routes used in the popup and options clients
│   │   ├── PromptRoutes.tsx # Routes used in the prompt client
│   │   ├── components # All reusable components
│   │   ├── lib # Standalone libraries, potentially split into node modules
│   │   ├── modules # Vertical slices of business logic, mostly redux code
│   │   ├── pages # Container components for app routes
│   │   ├── prompts # Container components for prompts
│   │   ├── static # Static assets that are compiled and processed
│   │   ├── store # Redux setup and configuration
│   │   ├── style # Global or common-use styles
│   │   ├── typings # Module typings for TypeScript
│   │   └── utils # Miscellanious utility functions and constants
│   ├── background_script # Extension background script
│   ├── content_script # Extension content script, injects inpage_script and communicates with background_script
│   ├── inpage_script # In-page injected script, manages WebLN
│   ├── options # Options client, full screen version of the app
│   ├── popup # Popup client, opened by clicking icon in toolbar
│   ├── prompt # Prompt client, opened by WebLN and BOLT-11 links
│   └── webln # WebLN implementation, injected via inpage_script
├── static # Static assets that don't go through any processing
├── dist-dev # Developer builds go here, not checked into git
└── dist-prod # Production builds go here, not checked into git
```

## Development

1. Run `yarn install && yarn run dev`
Expand Down Expand Up @@ -41,6 +76,10 @@ To make a production build, follow these steps

...regrettably, TBD

## Contributing

Please see the [Contributor Guidelines on the Wiki](https://github.com/wbobeirne/joule-extension/wiki/Contributor-Guidelines).

## Shoutouts

* Thanks to the [MetaMask](http://github.com/Metamask) team for establishing
Expand Down

0 comments on commit c9ace8c

Please sign in to comment.