From 897ff49396a4280661873b0a4a498f0f31fb807a Mon Sep 17 00:00:00 2001 From: Alexandre Date: Thu, 28 Dec 2017 01:43:45 -0300 Subject: [PATCH] Initial Commit --- .babelrc | 3 ++ .editorconfig | 9 +++++ .eslintrc.json | 6 ++++ .gitignore | 44 +++++++++++++++++++++++ CONTRIBUTING.md | 10 ++++++ LICENSE.md | 7 ++++ README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 57 ++++++++++++++++++++++++++++++ src/main.js | 0 tests/main.spec.js | 7 ++++ 10 files changed, 230 insertions(+) create mode 100644 .babelrc create mode 100644 .editorconfig create mode 100644 .eslintrc.json create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 package.json create mode 100644 src/main.js create mode 100644 tests/main.spec.js diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..469008f --- /dev/null +++ b/.babelrc @@ -0,0 +1,3 @@ +{ + presets: ['env'] +} diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..c6c8b36 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..c740a9e --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,6 @@ +{ + "extends": "airbnb-base", + "plugins": [ + "import" + ] +} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bc7fc55 --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e01fdb0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -m 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` + +*Remember that we have a pre-push hook with steps that analyzes and prevents mistakes.* + +**After your pull request is merged**, you can safely delete your branch. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..9933459 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2017 - Alexandre Kavalerski + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f202115 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Project Title + +One Paragraph of project description goes here + +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +### Prerequisites + +What things you need to install the software and how to install them + +``` +Give examples +``` + +### Installing + +A step by step series of examples that tell you have to get a development env running + +Say what the step will be + +``` +Give the example +``` + +And repeat + +``` +until finished +``` + +End with an example of getting some data out of the system or using it for a little demo + +## Running the tests + +Explain how to run the automated tests for this system + +### Break down into end to end tests + +Explain what these tests test and why + +``` +Give an example +``` + +### And coding style tests + +Explain what these tests test and why + +``` +Give an example +``` + +## Deployment + +Add additional notes about how to deploy this on a live system + +## Built With + +* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used +* [Maven](https://maven.apache.org/) - Dependency Management +* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds + +## Contributing + +Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). + +## Authors + +* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details + +## Acknowledgments + +* Hat tip to anyone who's code was used +* Inspiration +* etc diff --git a/package.json b/package.json new file mode 100644 index 0000000..ddbdea8 --- /dev/null +++ b/package.json @@ -0,0 +1,57 @@ +{ + "name": "btc-conv", + "version": "1.0.0", + "description": "A CLI to convert Bitcoin to any currency", + "main": "index.js", + "scripts": { + "clear": "rimraf bin", + "build": "npm run clear && ./node_modules/.bin/babel --out-dir bin src", + "build:watch": "npm run build -- --watch", + "lint": "./node_modules/.bin/eslint src/*.js", + "prepush": "npm run lint && npm run test", + "test": "./node_modules/.bin/mocha tests/**/*.spec.js --require babel-register --reporter landing", + "test:tdd": "npm run test -- --watch", + "test:coverage": "nyc npm test" + }, + "preferGlobal": true, + "bin": { + "btc-conv": "bin/main.js" + }, + "nyc": { + "reporter": [ + "text", + "html" + ], + "exclude": [ + "tests/**" + ] + }, + "repository": { + "type": "git", + "url": "git+https://github.com/AlexandreKavalerski/btc-converter.git" + }, + "keywords": [ + "js", + "tdd", + "library" + ], + "author": "Alexandre Kavalerski ", + "license": "MIT", + "bugs": { + "url": "https://github.com/AlexandreKavalerski/btc-converter/issues" + }, + "homepage": "https://github.com/AlexandreKavalerski/btc-converter#readme", + "devDependencies": { + "babel-cli": "^6.24.1", + "babel-preset-env": "^1.3.2", + "babel-register": "^6.24.0", + "chai": "^3.5.0", + "eslint": "^4.14.0", + "eslint-config-airbnb-base": "^11.2.0", + "eslint-plugin-import": "^2.6.1", + "husky": "^0.11.9", + "mocha": "^3.2.0", + "nyc": "^10.2.0", + "rimraf": "^2.6.1" + } +} diff --git a/src/main.js b/src/main.js new file mode 100644 index 0000000..e69de29 diff --git a/tests/main.spec.js b/tests/main.spec.js new file mode 100644 index 0000000..ac9ec2b --- /dev/null +++ b/tests/main.spec.js @@ -0,0 +1,7 @@ +import { expect } from 'chai'; + +describe('Main', () => { + it('should do...', () => { + expect(true).to.be.true; + }); +});