Skip to content

Commit b133646

Browse files
committed
Reorganize package.json files and their content
1 parent 07782b0 commit b133646

File tree

8 files changed

+45
-65
lines changed

8 files changed

+45
-65
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,4 @@ servers for a better decentralisation:
7676
- [UI](/app/README.md) React application connected to Dashboard server.
7777

7878

79+
## [MIT LICENSE]/LICENSE

app/README.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,26 @@
1-
# SmartVault Dashboard
1+
# Lightstreams Smart Vault Dashboard - React UI
22

3-
A decentralized application running on the Lightstreams Network
3+
This project correspond to the interface for the Smart Vault Dashboard UI
44

5-
## Introduction
5+
## Installation
66

7-
You can create a new account (i.e. wallet) and login with that account.
7+
Npm packages
8+
```
9+
$> npm install
10+
```
811

9-
## Features
12+
Create environment file `.env`
13+
```
14+
$> cp .env.sample .env
15+
```
1016

11-
This app features the latest tools and best practices for development.
12-
13-
-**React** — 16.7.0-alpha.0 with Hooks
14-
-**Redux** — State Management
15-
- 🛠 **Babel** — ES6 syntax, Airbnb & React/Recommended config
16-
- 🚀 **Webpack** — Hot Reloading, Code Splitting, Optimized Build
17-
- 💅 **CSS** — Styled Components
18-
-**Tests** — Jest, React Testing Library & Cypress
19-
- 💖 **Lint** — ESlint
20-
- 🐶 **Husky** — Prevent bad commits
17+
Define the a value for `SERVER_URL`, by default is `http://localhost:3000`.
2118

2219
## Getting started
2320

24-
1. Clone this repo using `https://github.com/lightstreams-network/smartvault-dashboard.git`
25-
2. Move to the appropriate directory: `cd smartvault-dashboard`.<br />
26-
3. Run `yarn` or `npm install` to install dependencies.<br />
27-
4. Run `npm start` to see the example app at `http://localhost:8080`.
28-
29-
## Commands
30-
3121
- `npm start` - start the dev server
3222
- `npm run build` - create a production ready build in `dist` folder
3323
- `npm run lint` - execute an eslint check
3424
- `npm run lint:fix` - execute an eslint and fix the errors
35-
- `npm test` - run all tests
36-
- `npm run test:watch` - run all tests in watch mode
37-
- `npm run test:cover` - coverage mode
38-
- `npm run cypress:open` - starts cypress
3925

4026

app/package-lock.json

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

app/package.json

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,12 @@
11
{
2-
"name": "smartvault-dashboard",
3-
"version": "1.0.0",
4-
"description": "A decentralized Smart Vault dashboard running on the Lightstreams Network",
5-
"main": "src/index.js",
2+
"name": "smartvault-dashboard-ui",
63
"scripts": {
74
"start": "cross-env NODE_ENV=development webpack-dev-server --open",
85
"build": "cross-env NODE_ENV=production webpack",
96
"lint": "eslint ./src/**/**.js",
107
"lint:fix": "eslint ./src/**/**.js --fix"
118
},
12-
"keywords": [
13-
"react",
14-
"redux",
15-
"webpack",
16-
"jest",
17-
"styled-components",
18-
"lightstreams",
19-
"lightstreams-network",
20-
"smart-vault"
21-
],
22-
"author": "Andrew Zappella <andrew.zappella@gmail.com>",
23-
"collaborators": [
24-
"Gabriel Garrido <gabriel@lightstreams.io>"
25-
],
26-
"license": "UNLICENSED",
9+
"license": "MIT",
2710
"private": true,
2811
"devDependencies": {
2912
"@babel/core": "^7.3.3",

package.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "smartvault-dashboard-server",
3+
"version": "0.9.0",
4+
"description": "A decentralized Smart Vault dashboard running on the Lightstreams Network Server",
5+
"author": "Gabriel Garrido",
6+
"license": "MIT",
7+
"homepage": "https://github.com/lightstreams-network/example-nodejs#readme",
8+
"repository": {
9+
"type": "git",
10+
"url": "git+https://github.com/lightstreams-network/example-nodejs.git"
11+
},
12+
"keywords": [
13+
"react",
14+
"nodejs",
15+
"express",
16+
"redux",
17+
"webpack",
18+
"jest",
19+
"styled-components",
20+
"lightstreams",
21+
"lightstreams-network",
22+
"smart-vault"
23+
]
24+
}

server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ And replace the value in `.env`:
4444
SMARTCONTRACT_DASHBOARD_ADDRESS="0x8484d16daBb428aed04481FA9C6f8F3dE213fe7e"
4545
```
4646

47-
### Run server
47+
### Getting started
4848

4949
Once we completed all the installation steps the latest step is to run the server:
5050
```

server/package-lock.json

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

server/package.json

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{
2-
"name": "lightstreams-demo",
3-
"version": "1.0.0",
4-
"description": "",
2+
"name": "smartvault-dashboard-server",
53
"main": "bin/www",
64
"scripts": {
75
"start": "NODE_PATH=. ./bin/www",
@@ -12,16 +10,6 @@
1210
"compile": "rm -rf ./build/contracts/*; truffle compile --all --reset",
1311
"postinstall": "rm -f node_modules/src; ln -nsf ../src node_modules/src"
1412
},
15-
"repository": {
16-
"type": "git",
17-
"url": "git+https://github.com/lightstreams-network/lightstreams-demo.git"
18-
},
19-
"author": "Gabriel Garrido",
20-
"license": "MIT",
21-
"bugs": {
22-
"url": "https://github.com/lightstreams-network/lightstreams-demo/issues"
23-
},
24-
"homepage": "https://github.com/lightstreams-network/lightstreams-demo#readme",
2513
"dependencies": {
2614
"bcrypt": "^3.0.5",
2715
"bignumber.js": "^8.1.1",

0 commit comments

Comments
 (0)