Giter VIP home page Giter VIP logo

node_jira_rest's Introduction

The Jira Grabber

Jira RESTful api using Node.js. The purpose is for you to download jira data from your jira server. This command-line application should be simple enough for anyone to use, including project/program managers.

TBD

Setup

Prerequisites

  • You must have Node.js installed. It's easy.

Installing

  1. Clone this repo to your desktop. Run this command in the directory where you want to code to live. git clone https://github.com/markcam1/node_jira_rest.git
  2. On your machine, install Node.js if you do not have it installed.
  3. Run install to download the dependencies npm install

Initial configuration

  • You will need to create an enviroment file to hold you configuration details like your username and password.
    • In the root folder (where all the files are located) create a file with the exact name = .env
    • In this file you will add the following environment-specific variables
    • JIRA_HOST: is the server where your jira server is hosted; yourdomain is your domain :)
    • JIRA_USER & JIRA_PW: are your username and password.
    • Save file when done
JIRA_HOST=https://jira.yourdomain.com/rest/api/2/issue/
JIRA_USER=your-username
JIRA_PASS=your-password

Instructions

Let's start and run the Jira Grabber

Open a command-line interface in the root directory

  1. Start the application node index.js

Select a function

  1. singleSearch
  2. tbd
  3. exit

singleSearch

Will search your jira server for one jira and return the results This will print a text file in the root directory name = jiraSingleSearch.txt

tbd

to be determined This is a placeholder function that is a work in progress

exit

quits the app

Built With

  • Node.js - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • request - Request is designed to be the simplest way possible to make http calls.
  • dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file
  • inquirer - A collection of common interactive command line user interfaces.
  • axios - Promise based HTTP client for the browser and node.js
  • file-system -This module makes file operations simple

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.

Versioning

Use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Mark Cameron - Initial work - Mark C

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • UC Berkeley Extension
  • “Wisdom is not a product of schooling but of the lifelong attempt to acquire it.” ― Albert Einstein

node_jira_rest's People

Contributors

markcam1 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.