Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steemit/faucet
Steemit Account Creation Web Application
https://github.com/steemit/faucet
faucet steem
Last synced: about 14 hours ago
JSON representation
Steemit Account Creation Web Application
- Host: GitHub
- URL: https://github.com/steemit/faucet
- Owner: steemit
- License: mit
- Created: 2017-08-09T08:18:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:16:05.000Z (3 months ago)
- Last Synced: 2024-10-29T12:17:59.195Z (3 months ago)
- Topics: faucet, steem
- Language: CSS
- Homepage:
- Size: 6.54 MB
- Stars: 23
- Watchers: 17
- Forks: 43
- Open Issues: 115
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Steem faucet
## Install
Download and install Node.js >= 7.7.1 then run
```
yarn install
```
## Init database
Set up and run migrations directly from the terminal using Sequelize CLI. Here is how to do:
```
yarn exec -- sequelize db:migrate --url 'mysql://username:password@hostname:port/database'
```
If your local db server does not support SSL, change the `ssl` option to `false` in `db/config/config.json`.
To seed the database with seed users:
```
yarn exec -- sequelize db:seed:all --url 'mysql://username:password@hostname:port/database'
```
Seed data can be added at: `db/seeders`
To start a-fresh:
```
yarn exec -- sequelize db:migrate:undo:all --url 'mysql://username:password@hostname:port/database'
```
#### Example one-liner
```
yarn exec -- sequelize db:migrate:undo:all --url 'mysql://root@localhost:3306/faucet' && yarn exec -- sequelize db:migrate --url 'mysql://root@localhost:3306/faucet' && yarn exec -- sequelize db:seed:all --url 'mysql://root@localhost:3306/faucet'
```
## Configure
Copy `.env.example` to `.env` and edit as needed. (`.env-admin.example` for faucet-admin)
## Run
### Faucet:
```
env $(tr "\\n" " " < .env) yarn start-dev # or just start, if you don't want nodemon
```
### Faucet-Admin
See the readme in `/admin`
## Docker
A Dockerfile is supplied. You will need to configure the app with environment variables.
See the file [.env.example](.env.example) for a full list of what you will need.
When running the Docker image locally, you will probably need to bind your mysqld to not only localhost
but also the IP used in Docker's network. You can then specify this IP in `DATABASE_URL`.
You can build and start the Docker image like this:
```
BRANCH="$(git rev-parse --abbrev-ref HEAD)"
docker build -t="$USER/faucet:$BRANCH" .
docker run -it -p 3000:3000 --env-file=.env "$USER/faucet:$BRANCH"
```
## Debugging
#### VSCode:
Add the following to `.vscode/launch.json` configurations array:
```json
{
"type": "node",
"request": "launch",
"name": "nodemon",
"runtimeExecutable": "${workspaceRoot}/node_modules/nodemon/bin/nodemon.js",
"program": "${workspaceFolder}/bin/www",
"restart": true,
"sourceMaps": true,
"outFiles": [],
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen",
"args": [
"--ignore src",
"| bunyan -o short"
],
"envFile": "${workspaceFolder}/.env",
}
```
## Testing
The `test` command will run three other scripts in sequence: static analysis (`eslint`), unit and integration tests (`jest`), and dependency security check (`nsp`).
You do need to supply dummy values for some required environment variables. Do so like this:
```
env $(tr "\\n" " " < .env.example) yarn test
```