Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit d7eeab4

Browse files
dantheman2865dantheman2865
committed
Merge branch 'master' into dev
# Conflicts: # README.md
2 parents 0fd347f + 1f20568 commit d7eeab4

File tree

1 file changed

+247
-0
lines changed

1 file changed

+247
-0
lines changed

‎README.md.orig‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
<<<<<<< HEAD
2+
# SmartSweeper
3+
4+
### Note
5+
SmartSweeper is currently in beta. You fund projects at your own risk.
6+
7+
### Description
8+
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs only on Windows 7, 8, and 10 at the moment. It isn't necessary to input your wallet passphrase to use SmartSweeper.
9+
10+
### Features
11+
* Create projects to organize promotions
12+
* Send funds to promotional wallets (1-500 wallets, inclusive)
13+
* Retrieve promotional funds from wallets that were not redeemed
14+
* Print paper wallets
15+
* User action logs and system logs
16+
17+
### Base Requirement
18+
* [SmartCash Node Client](https://smartcash.cc/wallets/) for Windows - 1.2.6+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
19+
20+
### Table of Contents
21+
* [Installation](#installation)
22+
* [Running from source](#running-from-source)
23+
* [Configuration](#configuration)
24+
* [Known issues](#known-issues)
25+
* [Other software used](#other-software-used)
26+
* [Contributing to SmartSweeper development](#contributing)
27+
28+
29+
## Installation
30+
Download a release and run the installer. You may need to run SmartSweeper as an administrator.
31+
32+
33+
## Running from source
34+
#### Additional Requirements
35+
* [Node.js](http://nodejs.org) - 8.9.0+
36+
* [npm](http://npmjs.com) - 5.6.0+
37+
38+
Run ```node -v``` and ```npm -v``` from a command prompt to make sure both are in your PATH. Open your SmartCash node client to make sure it is synchronized before launching SmartSweeper.
39+
40+
#### Installation
41+
=======
42+
SmartSweeper
43+
=============
44+
45+
NOTE
46+
---------------
47+
SmartSweeper is still in the development stage so it is unstable and missing functionality. DO NOT attempt to create transactions with this app.
48+
49+
50+
Description
51+
---------------
52+
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs only on Windows at the moment. It isn't necessary to input your wallet passphrase to use SmartSweeper.
53+
54+
55+
Features
56+
---------------
57+
* Create projects to organize promotions
58+
* Send funds to multiple promotional wallets
59+
* Retrieve promotional funds from wallets that were not redeemed
60+
* Print paper wallets
61+
* Access logs
62+
63+
64+
Releases
65+
---------------
66+
Releases are forthcoming. Please see the [dev branch](https://github.com/swiftlettech/smart-sweeper/tree/dev).
67+
68+
69+
Requirements
70+
---------------
71+
* [Node.js](http://nodejs.org) - 8.9.0+
72+
* [npm](http://npmjs.com) - 5.6.0+
73+
* [SmartCash Node Client](https://smartcash.cc/wallets/) for Windows - 1.2.2+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
74+
75+
Run node -v and npm -v from a command prompt to make sure they're in your PATH. Open your SmartCash desktop wallet application to make sure it is up to date before launching SmartSweeper.
76+
77+
78+
Installation
79+
---------------
80+
>>>>>>> master
81+
``` bash
82+
npm install
83+
```
84+
85+
<<<<<<< HEAD
86+
#### To run
87+
=======
88+
89+
To run
90+
---------------
91+
>>>>>>> master
92+
``` bash
93+
npm start
94+
```
95+
96+
97+
<<<<<<< HEAD
98+
## Configuration
99+
=======
100+
Configuration
101+
---------------
102+
>>>>>>> master
103+
SmartSweeper can be configured by modifying .env in the root directory. The app will create it for you the first time you load it, but you can create the file yourself prior to that, which will help if you didn't use the default SmartCash installation path. The default values for Windows are shown below.
104+
```
105+
rpc.host=127.0.0.1
106+
rpc.port=9678
107+
rpc.username=rpcusername
108+
rpc.password=rpcpassword
109+
smartcashPath=C:\Program Files\SmartCash\
110+
```
111+
112+
* rpc.host is the IP address that the SmartCash Node Client RPC server is bound to.
113+
<<<<<<< HEAD
114+
* rpc.port is the port that the SmartCash Node Client RPC server is listening on.
115+
=======
116+
* rpc.port is the port that the SmartCash node client RPC server is listening on.
117+
>>>>>>> master
118+
* rpc.username is the SmartCash Node Client RPC server username.
119+
* rpc.password is the SmartCash Node Client RPC server password.
120+
* smartcashPath is the full path to your SmartCash Node Client installation. You must include a trailing slash.
121+
122+
123+
<<<<<<< HEAD
124+
Your SmartCash Node Client must be started with the following arguments:
125+
```
126+
=======
127+
Your SmartCash wallet must be started with the following arguments:
128+
```
129+
-txindex=1 (if SmartCash Node Client is < v1.2.3)
130+
>>>>>>> master
131+
-server
132+
-rpcbind=127.0.0.1
133+
-rpcport=9678
134+
-rpcuser=rpcusername
135+
-rpcpassword=rpcpassword
136+
```
137+
138+
<<<<<<< HEAD
139+
If it isn't running, SmartSweeper will attempt to start it for you with the above arguments. You can also [edit your node client's smartcash.conf file](https://smartcash.freshdesk.com/support/solutions/articles/35000038702-smartcash-conf-configuration-file). Please don't do this with your client running.
140+
141+
```
142+
=======
143+
If it isn't running, SmartSweeper will start it for you with the above arguments. You can also [edit your wallet's smartcash.conf file](https://smartcash.freshdesk.com/support/solutions/articles/35000038702-smartcash-conf-configuration-file). Please don't do this with your wallet running.
144+
145+
```
146+
txindex=1 (if SmartCash Node Client is < v1.2.3)
147+
>>>>>>> master
148+
server=1
149+
rpcbind=127.0.0.1
150+
rpcport=9678
151+
rpcuser=rpcusername
152+
rpcpassword=rpcpassword
153+
```
154+
155+
The values of rpc.host, rpc.port, rpc.username, and rpc.password in .env must match those in the program arguments or the smartcash.conf file.
156+
157+
158+
<<<<<<< HEAD
159+
#### User files
160+
The database (smart-sweeper.json), the app config file (smart-sweeper-config.json), the saved dashboard data file (smart-sweeper-data.json) and the log files are saved in the following folder:
161+
162+
* **Windows**: %APPDATA%/SmartSweeper
163+
164+
**It is strongly recommended that you regularly back up smart-sweeper.json to a safe place.**
165+
166+
The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). The user logs record user actions while the system logs record system actions and errors (and includes transaction ids and public keys).
167+
168+
169+
## Known issues
170+
* SmartSweeper may not open the SmartCash Node Client. If smartcash.conf hasn't been modified with the info above, SmartSweeper won't work if the node client is run manually.
171+
* electron-store error "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
172+
* Can't connect to the node client via RPC when it's syncing (SmartSweeper will display the "Can't connect to SmartCash Node Client." error). This will cause some actions to fail and some project data updates to not occur.
173+
* Claimed funds info on the dashboard and the sweep funds page becomes inaccurate after one or more projects have been swept.
174+
* Empty log files are sometimes created in the root SmartSweeper data folder.
175+
* There is lag when entering text into input fields.
176+
177+
178+
## Other software used
179+
=======
180+
User files
181+
---------------
182+
The database (smart-sweeper.json), the app config file (smart-sweeper-config.json) and the log files are saved in the following folders:
183+
184+
* **Windows**: %APPDATA%/SmartSweeper
185+
186+
The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). **It is recommended that you back up smart-sweeper.json to a safe place.**
187+
188+
189+
KNOWN ISSUES
190+
---------------
191+
* electron-store error: "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
192+
193+
194+
Other software used
195+
-------------------
196+
>>>>>>> master
197+
Software | License
198+
-------- | --------
199+
[AngularJS](http://angularjs.org) | MIT
200+
[AngularUI Bootstrap](https://github.com/angular-ui/bootstrap) | MIT
201+
[Bootstrap](https://getbootstrap.com/docs/3.3/) | MIT
202+
[clipboard.js](https://clipboardjs.com) | MIT
203+
<<<<<<< HEAD
204+
[delayed-call](https://github.com/finnolav/delayed-call) | MIT
205+
[devtron](https://github.com/electron/devtron) | MIT
206+
[electron](https://github.com/electron/electron) | MIT
207+
[electron-builder](https://github.com/electron-userland/electron-builder) | MIT
208+
[electron-debug](https://github.com/sindresorhus/electron-debug) | MIT
209+
[electron-is-dev](https://github.com/sindresorhus/electron-is-dev) | MIT
210+
[electron-store](https://github.com/sindresorhus/electron-store) | MIT
211+
[electron-unhandled](https://github.com/sindresorhus/electron-unhandled) | MIT
212+
=======
213+
[devtron](https://github.com/electron/devtron) | MIT
214+
[electron](https://github.com/electron/electron) | MIT
215+
[electron-debug](https://github.com/sindresorhus/electron-debug) | MIT
216+
[electron-is-dev](https://github.com/sindresorhus/electron-is-dev) | MIT
217+
[electron-store](https://github.com/sindresorhus/electron-store) | MIT
218+
>>>>>>> master
219+
[electron-util](https://github.com/sindresorhus/electron-util) | MIT
220+
[elemon](https://github.com/manidlou/elemon) | MIT
221+
[exp-config](https://github.com/ExpressenAB/exp-config) | MIT
222+
[melanke-watchjs](https://github.com/melanke/Watch.JS) | MIT
223+
<<<<<<< HEAD
224+
[Moment.js](https://github.com/moment/moment) | MIT
225+
=======
226+
>>>>>>> master
227+
[node-smartcash](https://github.com/miyakoj/node-smartcash) | MIT
228+
[ps-node](https://github.com/neekey/ps) | MIT
229+
[request](https://github.com/request/request) | Apache-2.0
230+
[smartcashjs-lib](https://github.com/SmartCash/SmartCashjs-lib) | MIT
231+
[SmartCash Paper Wallet Generator](https://github.com/SmartCash/PaperWalletGenerator) | ?
232+
[winston](https://github.com/winstonjs/winston) | MIT
233+
234+
235+
<<<<<<< HEAD
236+
[The SmartCash Insight Explorer](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.
237+
238+
### Icons and graphics
239+
* Basic app icons: [Font Awesome](http://fontawesome.io)
240+
* Progress spinner: [preloaders.net](https://preloaders.net)
241+
242+
243+
## Contributing
244+
You can [contribute to the development of SmartSweeper](CONTRIBUTING.md) by filing a bug report or by submitting a pull request. All contributors must follow our [code of conduct](docs/CODE_OF_CONDUCT.md).
245+
=======
246+
[The SmartCash Insight Explorer API](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.
247+
>>>>>>> master

0 commit comments

Comments
 (0)