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.
- You must have Node.js installed. It's easy.
- 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
- On your machine, install Node.js if you do not have it installed.
- Run install to download the dependencies
npm install
- 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
Let's start and run the Jira Grabber
Open a command-line interface in the root directory
- Start the application
node index.js
Select a function
- singleSearch
- tbd
- exit
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
to be determined This is a placeholder function that is a work in progress
- 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
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.
Use SemVer for versioning. For the versions available, see the tags on this repository.
- Mark Cameron - Initial work - Mark C
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- UC Berkeley Extension
- “Wisdom is not a product of schooling but of the lifelong attempt to acquire it.” ― Albert Einstein