Skip to content

Commit 6dc1d70

Browse files
abranheabranhe
committed
init
0 parents  commit 6dc1d70

8 files changed

Lines changed: 333 additions & 0 deletions

File tree

‎.editorconfig‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# EditorConfig
2+
# https://EditorConfig.org
3+
#
4+
# Build with init-editorconfig
5+
# https://github.com/abranhe/init-editorconfig
6+
7+
root = true
8+
9+
[*]
10+
indent_style = tab
11+
end_of_line = lf
12+
charset = utf-8
13+
trim_trailing_whitespace = true
14+
insert_final_newline = true
15+
16+
[*.yml]
17+
indent_style = space
18+
indent_size = 2

‎.gitignore‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
8+
# Runtime data
9+
pids
10+
*.pid
11+
*.seed
12+
*.pid.lock
13+
14+
# Directory for instrumented libs generated by jscoverage/JSCover
15+
lib-cov
16+
17+
# Coverage directory used by tools like istanbul
18+
coverage
19+
20+
# nyc test coverage
21+
.nyc_output
22+
23+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24+
.grunt
25+
26+
# Bower dependency directory (https://bower.io/)
27+
bower_components
28+
29+
# node-waf configuration
30+
.lock-wscript
31+
32+
# Compiled binary addons (https://nodejs.org/api/addons.html)
33+
build/Release
34+
build
35+
36+
# Dependency directories
37+
node_modules/
38+
jspm_packages/
39+
40+
# TypeScript v1 declaration files
41+
typings/
42+
43+
# Optional npm cache directory
44+
.npm
45+
46+
# Optional eslint cache
47+
.eslintcache
48+
49+
# Optional REPL history
50+
.node_repl_history
51+
52+
# Output of 'npm pack'
53+
*.tgz
54+
package-lock.json
55+
56+
# Yarn Integrity file
57+
.yarn-integrity
58+
59+
# dotenv environment variables file
60+
.env
61+
62+
# next.js build output
63+
.next
64+
65+
*.DS_Store
66+
67+
/add

‎.travis.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
language: node_js
2+
node_js:
3+
- "6"
4+
- "8"
5+
- "10"
6+
7+
notifications:
8+
email: false

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Abraham Hernandez & The Hurricanes
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<p align="center" id="top">
2+
<a href="https://www.npmjs.com/package/shellhacks"><img src="https://cdn.abranhe.com/projects/ShellHacks/ShellHacks.png" width="300"></a>
3+
<br>
4+
<br>
5+
<br>
6+
<a href="https://www.npmjs.com/package/shellhacks"><b>shellhacks</b></a>
7+
: The ShellHacks CLI 🐚
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://travis-ci.org/abranhe/shellhacks-cli"><img src="https://img.shields.io/travis/abranhe/shellhacks-cli.svg?logo=travis" /></a>
12+
<a href="https://github.com/abranhe/shellhacks-cli/blob/master/LICENSE"><img src="https://img.shields.io/github/license/abranhe/shellhacks-cli.svg" /></a>
13+
<a href="https://github.com/abranhe/shellhacks"><img src="https://img.shields.io/npm/v/shellhacks.svg" /></a>
14+
<a href="https://shellhacks.net"><img src="https://cdn.abranhe.com/projects/shellhacks/2018/badge.svg" /></a>
15+
</p>
16+
17+
# See
18+
19+
- [Overview](#overview)
20+
- [Install](#install)
21+
- [Related](#related)
22+
- [Team](#team)
23+
- [License](#license)
24+
25+
# Overview
26+
27+
There is no way you are in Hackathon without using your terminal, that's why **ShellHacks** CLI is here. It is the easiest way to find information about ShellHack in the most geeky way 🤓.
28+
29+
# Install
30+
31+
```
32+
$ npm install shellhacks
33+
```
34+
35+
# Adding badge
36+
37+
You can then import the badges from `./node_modules/shellhacks`, for example `./node_modules/shellhacks/badges/2018.svg`.
38+
39+
You can also add it from [shellhacks](https://github.com/abranhe/shellhacks).
40+
41+
# CLI
42+
43+
```console
44+
The ShellHacks CLI 🐚
45+
46+
Usage:
47+
$ shellhacks [options|flags...]
48+
49+
Options:
50+
wtp Where to post your projects (devpost)
51+
badges View how to add a Shellhacks badge
52+
web Opens ShellHack website
53+
github Opens ShellHack Github Account
54+
discord Opens UPEFIU discord server
55+
56+
Flags:
57+
-f, --feedback Send a feedback
58+
-h, --help Show help message and close
59+
-v, --version View package Version
60+
61+
Example
62+
$ shellhacks --feedback
63+
Join the Discord server app for support!
64+
```
65+
66+
# Related
67+
68+
- [shellhacks](https://github.com/abranhe/shellhacks): add a beautiful ShellHack badge to your projects descriptions.
69+
70+
# Team
71+
72+
| ![abranhe](https://avatars3.githubusercontent.com/u/21347264?s=50) | ![adriel](https://avatars2.githubusercontent.com/u/36480978?s=50) | ![user](https://png.icons8.com/office/50/000000/administrator-male.png) |
73+
| --- | --- | -- |
74+
| [Carlos Abraham](https://github.com/abranhe) | [Adriel Camargo](https://github.com/adriel1221) | [Alejandro... ](https://github.com/Alexellokito)
75+
76+
# License
77+
78+
> ShellHacks logo is owned by [shelhacks.net](https://shelhacks.net)
79+
80+
[MIT](https://github.com/abranhe/init-pkg-json/blob/master/LICENSE) License © [Carlos Abraham](https://github.com/abranhe/) & [The Hurricanes](https:/github.com/TheHurricanes)
81+
82+
<p align="center">
83+
<a href="#top">🐚 TOP ⬆</a>
84+
</p>

‎badges/2018.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎cli.js‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
#!/usr/bin/env node
2+
'use strict';
3+
const meow = require('meow');
4+
const open = require('opn');
5+
6+
const web = 'https://shellhacks.net';
7+
const wtp = 'https://shellhacks-2018.devpost.com/';
8+
const github = 'https://github.com/ShellHackFIU';
9+
const discord = 'https://discordapp.com/invite/upefiu';
10+
const badges = 'https://github.com/abranhe/shellhacks';
11+
12+
const cli = meow(`
13+
Usage:
14+
$ shellhacks [options|flags...]
15+
16+
Options:
17+
web Opens ShellHack website
18+
wtp Where to post your projects (devpost)
19+
badges View how to add a Shellhacks badge
20+
github Opens ShellHack Github Account
21+
discord Opens UPEFIU discord server
22+
23+
Flags:
24+
-f, --feedback Send a feedback
25+
-h, --help Show help message and close
26+
-v, --version View package Version
27+
28+
Example
29+
$ shellhacks --feedback
30+
Join the Discord server app for support!
31+
$ shellhacks web
32+
`,{
33+
flags: {
34+
help: {
35+
type: 'boolean',
36+
alias: 'h'
37+
},
38+
version: {
39+
type: 'boolean',
40+
alias: 'v'
41+
},
42+
feedback: {
43+
type: 'boolean',
44+
alias: 'f'
45+
}
46+
}
47+
});
48+
49+
if(!cli.input.length == 1 || cli.input.length > 1) {
50+
cli.showHelp();
51+
}
52+
53+
if(cli.flags.feedback) {
54+
console.log('Join the Discord server app for support!\n');
55+
cli.showHelp();
56+
}
57+
58+
if(cli.input[0] === 'badges') {
59+
open(badges);
60+
process.exit();
61+
} else {
62+
cli.showHelp();
63+
}
64+
65+
if(cli.input[0] === 'wtp') {
66+
open(wtp);
67+
process.exit();
68+
} else {
69+
cli.showHelp();
70+
}
71+
72+
if(cli.input[0] === 'discord') {
73+
open(discord);
74+
process.exit();
75+
} else {
76+
cli.showHelp();
77+
}
78+
79+
if(cli.input[0] === 'web') {
80+
open(web);
81+
process.exit();
82+
} else {
83+
cli.showHelp();
84+
}
85+
86+
if(cli.input[0] === 'github') {
87+
open(github);
88+
process.exit();
89+
} else {
90+
cli.showHelp();
91+
}

‎package.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"name": "shellhacks",
3+
"version": "2018.9.16-ALPHA",
4+
"description": "The ShellHacks CLI 🐚",
5+
"main": "cli.js",
6+
"scripts": {
7+
"test": "echo its-good"
8+
},
9+
"bin": {
10+
"shellhacks": "cli.js"
11+
},
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/abranhe/shellhacks-cli.git"
15+
},
16+
"keywords": [
17+
"shellhacks",
18+
"hackathon",
19+
"hacker",
20+
"porgramming",
21+
"cli",
22+
"miami",
23+
"computer-science"
24+
],
25+
"files": [
26+
"cli.js",
27+
"badges/"
28+
],
29+
"author": {
30+
"name": "Carlos Abraham",
31+
"email": "abraham@abranhe.com",
32+
"web": "abranhe.com"
33+
},
34+
"license": "MIT",
35+
"bugs": {
36+
"url": "https://github.com/abranhe/shellhacks-cli/issues"
37+
},
38+
"homepage": "https://github.com/abranhe/shellhacks-cli#readme",
39+
"dependencies": {
40+
"meow": "^5.0.0",
41+
"opn": "^5.3.0"
42+
}
43+
}

0 commit comments

Comments
 (0)