Skip to content

Commit

Permalink
chore: add func meta
Browse files Browse the repository at this point in the history
  • Loading branch information
Dafyh committed Apr 8, 2019
1 parent 1ea7735 commit c3a4ffd
Show file tree
Hide file tree
Showing 14 changed files with 6,874 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
indent_size = 4
indent_style = space
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
6 changes: 6 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "@slimio/eslint-config",
"rules": {
"max-lines-per-function": "off"
}
}
18 changes: 18 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
test/
tests/
coverage/
.nyc_output/
.circleci/
docs/
jsdoc/
test/test.js
jsdoc.json
.editorconfig
.eslintrc
.gitignore
tsconfig.json
commitlint.config.js
.env
.travis.yml
CONTRIBUTING.md
CHANGELOG.md
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to Slim.io

Contributions to Slim.io include code, documentation, answering user questions,
running the project's infrastructure, and advocating for all types of Slim.io
users.

The Slim.io project welcomes all contributions from anyone willing to work in
good faith with other contributors and the community. No contribution is too
small and all contributions are valued.

This guide explains the process for contributing to the Slim.io project's.

## [Code of Conduct](https://github.com/SlimIO/Governance/blob/master/CODE_OF_CONDUCT.md)

The Slim.io project has a
[Code of Conduct](https://github.com/SlimIO/Governance/blob/master/CODE_OF_CONDUCT.md)
that *all* contributors are expected to follow. This code describes the
*minimum* behavior expectations for all contributors.

See [details on our policy on Code of Conduct](https://github.com/SlimIO/Governance/blob/master/COC_POLICY.md).

<a id="developers-certificate-of-origin"></a>
## Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

* (a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

* (b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

* (c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

* (d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 SlimIO
Copyright (c) 2018 SlimIO

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# Registry-SDK
Node.js SDK For the Registry API
# test
![version](https://img.shields.io/badge/version-1.0.0-blue.svg)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/SlimIO/is/commit-activity)
![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)

test

## Requirements
- Node.js v10 or higher

## Getting Started

This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).

```bash
$ npm i @slimio/test
# or
$ yarn add @slimio/test
```

## Usage example
TBC

## API
TBC

## License
MIT
3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ["@commitlint/config-conventional"]
};
26 changes: 26 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

// Require Third-party dependencies
const { get, post } = require("httpie");

// Constantes
const PORT = 1337;
const URL = `http://localhost:${PORT}`;

/**
* @async
* @function meta
* @description
*/
async function meta() {
try {
const { data } = await get(URL);
throw data.uptime;
}
catch (error) {
console.error(error);
}
}

meta();


19 changes: 19 additions & 0 deletions jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"opts": {
"encoding": "utf8",
"destination": "./docs/",
"recurse": true,
"template": "node_modules/@escommunity/minami"
},
"source": {
"include": [
"index.js"
],
"exclude": [
"node_modules",
"client"
],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
}
}
Loading

0 comments on commit c3a4ffd

Please sign in to comment.