Updated Readme
This commit is contained in:
parent
9e468f86b3
commit
f8df1eab12
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2022 BRAVO68WEB <me@bravo68web.me> (https://bravo68web.me)
|
||||
|
||||
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.
|
58
README.md
58
README.md
|
@ -1,2 +1,58 @@
|
|||
# Node Deployer
|
||||
# Welcome to node-deployer 👋
|
||||
[![Version](https://img.shields.io/npm/v/node-deployer.svg)](https://www.npmjs.com/package/node-deployer)
|
||||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
|
||||
[![Twitter: bravo68web](https://img.shields.io/twitter/follow/bravo68web.svg?style=social)](https://twitter.com/bravo68web)
|
||||
|
||||
> Ad DevOps CD tool build to auto pull changes from git repository into a remote server"
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
git clone https://git.itsmebravo.dev/bravo68web/node-deployer
|
||||
cd node-deployer
|
||||
npm install
|
||||
```
|
||||
|
||||
## Configure
|
||||
|
||||
Create a `.env` file with the following content:
|
||||
```.env
|
||||
MASTER_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
PORT=xxxx
|
||||
MONGODB_URI=mongodb://xxx.xxx.xxx.xxx/node-deployer
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
yarn run prod
|
||||
```
|
||||
|
||||
## Author
|
||||
|
||||
👤 **Bravo68web**
|
||||
|
||||
* Website: https://bravo68web.me
|
||||
* Twitter: [@bravo68web](https://twitter.com/bravo68web)
|
||||
* Github: [@bravo68web](https://github.com/bravo68web)
|
||||
* LinkedIn: [@bravo68web](https://linkedin.com/in/bravo68web)
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions, issues and feature requests are welcome!
|
||||
|
||||
Feel free to check [issues page](https://git.itsmebravo.dev/bravo68web/node-deployer/issues).
|
||||
|
||||
## Show your support
|
||||
|
||||
Give a ⭐️ if this project helped you!
|
||||
|
||||
|
||||
## 📝 License
|
||||
|
||||
Copyright © 2022 [Bravo68web](https://github.com/bravo68web).
|
||||
|
||||
This project is [MIT](LICENSE) licensed.
|
||||
|
||||
***
|
||||
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
|
15
package.json
15
package.json
|
@ -1,8 +1,17 @@
|
|||
{
|
||||
"name": "node-deployer",
|
||||
"version": "0.0.0",
|
||||
"version": "1.0.0",
|
||||
"main": "src",
|
||||
"private": true,
|
||||
"author": {
|
||||
"name": "BRAVO68WEB",
|
||||
"email": "me@bravo68web.me",
|
||||
"url": "https://bravo68web.me"
|
||||
},
|
||||
"git": {
|
||||
"url": "https://git.itsmebravo.dev/bravo68web/node-deployer"
|
||||
},
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"start": "node .",
|
||||
"test": "jest",
|
||||
|
@ -16,7 +25,9 @@
|
|||
},
|
||||
"jest": {
|
||||
"testEnvironment": "node",
|
||||
"setupFilesAfterEnv": ["<rootDir>/test/setup.js"]
|
||||
"setupFilesAfterEnv": [
|
||||
"<rootDir>/test/setup.js"
|
||||
]
|
||||
},
|
||||
"devDependencies": {
|
||||
"apidoc": "^0.20.0",
|
||||
|
|
Loading…
Reference in New Issue