Skip to content

Commit

Permalink
Hit Markdown and JSON files with the prettier hammer
Browse files Browse the repository at this point in the history
  • Loading branch information
Shadowfiend committed Aug 2, 2021
1 parent 2899017 commit 8a90e88
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 19 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ your dev browser of choice:

- [Firefox instructions](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)
- [Chrome, Brave, and Opera instructions](https://developer.chrome.com/docs/extensions/mv3/getstarted/#manifest)
* Note that these instructions are for Chrome, but substituting
`brave://extensions` or `opera://extensions` for `chrome://extensions`
depending on browser should get you to the same buttons.
- Note that these instructions are for Chrome, but substituting
`brave://extensions` or `opera://extensions` for `chrome://extensions`
depending on browser should get you to the same buttons.

Extension bundles for each browser are in `dist/<browser>`.

Expand Down
1 change: 0 additions & 1 deletion api/keys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ the keys api should store keys of these types:
metamask style 12 words
bip39 24 words generated keys
read only keys/public addresses

4 changes: 1 addition & 3 deletions manifest/manifest.development.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"background": {
"scripts": [
"dev-utils/extension-reload.js"
]
"scripts": ["dev-utils/extension-reload.js"]
}
}
4 changes: 1 addition & 3 deletions manifest/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@

"background": {
"persistent": true,
"scripts": [
"background.js"
]
"scripts": ["background.js"]
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"lint:docs": "prettier -c '**/*.md'",
"lint:docs:fix": "prettier -w '**/*.md'",
"lint:js": "eslint .",
"lint:js:fix": "eslint .",
"lint:js:fix": "eslint . --fix",
"test": "echo \"nothing to do\""
},
"workspaces": [
Expand Down
23 changes: 15 additions & 8 deletions ui/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Tally Extension Frontend 🐕

![Screen + Browser Mock](https://user-images.githubusercontent.com/1918798/125732391-29da0e00-0796-49bb-895d-35de187b141d.png)

Welcome to the frontend portion of the Tally browser extension. This is the React portion of the codebase which handles UI related states, and communicates with the background script API `@tallyho/tally-api`. The intent is for all communication with outside APIs to strictly happen within `@tallyho/tally-api`, not here. This frontend only contains what's needed to provide the visual goodness!
Expand All @@ -7,15 +8,16 @@ Welcome to the frontend portion of the Tally browser extension. This is the Reac

Make sure to have these installed,

* [Git](https://git-scm.com/)
* [Node](https://nodejs.org/en/) (Tested on v12.17.0)
* [Yarn](https://yarnpkg.com/)
- [Git](https://git-scm.com/)
- [Node](https://nodejs.org/en/) (Tested on v12.17.0)
- [Yarn](https://yarnpkg.com/)

Check out these docs,
* [Redux Toolkit](https://redux-toolkit.js.org/api/configureStore)
* [react-chrome-extension-router](https://github.com/kelsonpw/react-chrome-extension-router)
* [styled-jsx](https://github.com/vercel/styled-jsx)
* [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)

- [Redux Toolkit](https://redux-toolkit.js.org/api/configureStore)
- [react-chrome-extension-router](https://github.com/kelsonpw/react-chrome-extension-router)
- [styled-jsx](https://github.com/vercel/styled-jsx)
- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)

## Running in development 🚀

Expand All @@ -24,6 +26,7 @@ First, install the node modules:
```bash
yarn install
```

If you run into `The engine "node" is incompatible with this module.`, try adding `--ignore-engines` for now.

Then, start up the dev server:
Expand All @@ -43,6 +46,7 @@ Load the unpacked extension for your web browser via the `/build` directory. Cur
3. To make this page available to the router links, register the route at the end of the file

For example,

```
import { registerRoute } from '../config/routes';
import CorePage from '../components/Core/CorePage';
Expand All @@ -56,7 +60,7 @@ export default function ExamplePage() {
<style jsx>
{`
.example_class {
color:
color:
}
`}
</style>
Expand All @@ -66,6 +70,7 @@ export default function ExamplePage() {
registerRoute('earn', Earn);
```

⚠️ Styles are inside of the jsx via [styled-jsx](https://github.com/vercel/styled-jsx)

### How to link/navigate to a page
Expand All @@ -86,9 +91,11 @@ import { routes } from '../../config/routes';
/>
</Link>
```

⚠️ The key used in the routes object is set at the end of a page file with `registerRoute('example', Example);`. Typically the key name is page's name but in camel case.

## Primary file structure 📁

```
/pages
# Folder for components that serve the components for pages, primarily tabs
Expand Down

0 comments on commit 8a90e88

Please sign in to comment.