chore: favicon and manifest changes

refactor: styles revamp refactor: code cleanup and commenting
andrerfneves · Nov 5, 2018 · 3ec1cc4 · 3ec1cc4
1 parent 689e3e8
commit 3ec1cc4
Show file tree

Hide file tree

Showing 29 changed files with 1,325 additions and 273 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,11 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
 # dependencies
 /node_modules
 /.pnp
 .pnp.js
 
+# keys
+ga.js
+
 # testing
 /coverage
 

diff --git a/README.md b/README.md
@@ -6,4 +6,29 @@
 
 Lightning Decoder is a utility app that helps with understanding the individual parts of a Lightning Network Invoice/Payment Request (BOLT 11). It aims to be a tool for  developers building applications on top of the LN network.
 
+## Installing & Developing
+
+To run this application locally, simply clone the repo and run `yarn` or `npm install` to install all dependencies. You should then be able to run `yarn start` or `npm start` to spin up a local development server.
+
+## Building for Production
+
+To build the assets for production, use script `yarn build` or `npm run build`. A `/build` top-level folder will be created, hosting all of the necessary files and assets bundled for serving in production.
+
+## Deployment
+
+This application uses Now to handle deployment. You should modify the configuration in `now.json` to match your needs, and then run `now`. Now will pick up
+
+## Analytics Configuration
+
+You will note that there's a missing `ga.js` file inside of `/constants` folder. In order to bundle the application correctly, you need to create your own Google Analytics `GA_CODE` variable in a file called `ga.js`.
+
+```js
+// Google Analytics Constants
+export const GA_CODE = 'UA-XXXXXXX-X';
+```
+
+## Contributions
+
+I'm always aiming to introduce new features and improvements to the application. If you see a need and would like to contribute, please send a PR with detailed descriptions and I'll evaluate as early as I can.
+
 MIT Licensed 2018
diff --git a/package.json b/package.json
@@ -17,6 +17,7 @@
     "node-sass": "^4.9.4",
     "react": "^16.6.0",
     "react-dom": "^16.6.0",
+    "react-ga": "^2.5.3",
     "react-scripts": "2.1.1",
     "safe-buffer": "^5.1.1",
     "secp256k1": "^3.4.0",

diff --git a/public/favicon.ico b/public/favicon.ico
diff --git a/public/favicon.png b/public/favicon.png
diff --git a/public/index.html b/public/index.html
@@ -2,10 +2,23 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
-    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="theme-color" content="#000000">
-    <link rel="manifest" href="%PUBLIC_URL%/manifest.json">
+    <link
+      rel="shortcut icon"
+      type="image/png"
+      href="%PUBLIC_URL%/favicon.png"
+    >
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    >
+    <meta
+      name="theme-color"
+      content="#000000"
+    >
+    <link
+      rel="manifest"
+      href="%PUBLIC_URL%/manifest.json"
+    >
     <title>
       Lightning Decoder | Decode Lightning Network BOLT11 Invoices
     </title>

diff --git a/public/manifest.json b/public/manifest.json
@@ -1,6 +1,6 @@
 {
-  "short_name": "React App",
-  "name": "Create React App Sample",
+  "short_name": "Lightning Decoder",
+  "name": "Lightning Decoder",
   "icons": [
     {
       "src": "favicon.ico",
@@ -11,5 +11,5 @@
   "start_url": ".",
   "display": "standalone",
   "theme_color": "#000000",
-  "background_color": "#ffffff"
+  "background_color": "#f3f3f3"
 }
diff --git a/src/App.js b/src/App.js
@@ -6,7 +6,7 @@ import { formatDetailsKey } from './utils/keys';
 import { formatTimestamp } from './utils/timestamp';
 
 // Styles
-import './app.scss';
+import './assets/styles/main.scss';
 
 // Assets
 import arrowImage from './assets/images/arrow.svg';

diff --git a/src/app.scss b/src/app.scss
diff --git a/src/assets/styles/base/colors.scss b/src/assets/styles/base/colors.scss
@@ -0,0 +1,8 @@
+// Colors
+$app-background: #292929;
+$background-primary: #000000;
+$text-primary: #f3f3f3;
+$text-secondary: #838383;
+$text-tertiary: #979797;
+$error-color: #3e0203;
+$border-color: #212020;