cassandragoose/robo-clone

Robo Clone

This project is not intended for use by anyone at this time.

Usage

• Run npm install -g roborepo
• Navigate to the directory where you would like the student repos to be cloned to
• Get the API key from the #frontend Slack channel
• Run robo-clone --key APIKEYHERE

Program Overview

(Please do not panic when you see an API key in the gif below. It has been revoked and is used for illustrative purposes only) This application was built to streamline the process of cloning down students' GH repos and running installation for each of them. Now instead of manually grabbing each link, changing directories, and running npm i, you can run one command to clone all of the repos you want! Answer the questions prompted by Robo Clone and you'll have your projects up and running in no time!

Tech Used

• Node
• enquirer
• shelljs
• node-fetch
• dotenv

Troubleshooting

• If students are private, make sure to accept invitation before running robo-clone.
• If you run into permission errors when running robo-clone, run sudo chown -R $USER <FILE PATH> in the directory that you are running the command.
  • For example, for the error Missing write access to /usr/local/lib/node_modules, you can run sudo chown -R $USER /usr/local/lib/node_modules.
• Note: This tool expects the columns of the spreadsheet to be in this order:

Timestamp	Your name (or list all names of project pair/group):	Current Mod:	Project:	Project Manager:	GitHub Repo Link:	Deployed Project Link (if applicable):	Anything else?	Project:	Project Manager:	DTR Link (if applicable):	GitHub Repo Link:	Project Board Link:	Deployed Project Link (if applicable):	Project:	DTR Link (if applicable):	GitHub Repo Link:	Project Board Link:	Deployed Project Link (if applicable):	Any additional information to set up the project locally?	Anything else?	Project Manager:		Please note any extensions you did (if applicable):

Future Iterations

• Pull from column names instead of hardcoded index
• Add more inclusive regex
• Fix user experience with API key
• Auto-test functionality
• More specific error handling for incorrectly formatted data, missing links, etc.

Contributors

• Travis Rollins
• Cassandra Torskey
• Heather Faerber

robo-clone's Issues

As a user, I want to work with only specific data

• filter by mod, date, manager
  • account for varying names and capitalization
• accept these arguments from the command line before running

Refactor regex to include any other symbols students might use to separate names

As a user, I want to have the repos cloned.

• auto clone all repos and npm install

As a user, I can feed data to the app.

• What data do we need to access the sheet?

  • Grab the sheet id from the target sheet.
  • Following https://developers.google.com/sheets/api/quickstart/nodejs, we needed to create a project to get a google sheets api and then grab an api key.
  • Make a get request with the following data: https://sheets.googleapis.com/v4/spreadsheets/1myndS4dsD6B-7OzKj75SS9XwFoKguoq3QBQUMaqPEns/values/FormResponses1!A2:B2?valueRenderOption=FORMATTED_VALUE&key=AIzaSyDnuHjqERqRsCZVTMC0YTtnzwtBGdHovnQ

• read the data into the js

  • we fetched all the data using node fetch. note that we had to specify this project as a module in the package json to get the imports to work
  • then, we mapped our data into a format that we want.

Research Terminal Functionality

• determine how to ask a user questions in the terminal
  • check out flashcards project or calendly

Error Handling:

[ ] blank or invalid fields should be skipped with a message displayed to user to manually handle those instances

[ ] how to use the application from within a directory

As a user, I want to be able to use this program as an executable.

• make the file executable
• publish to npm

Data Research

• determine how to feed data based on the google sheet link or if CSV feed is preferable
  • determine if authorization needed
• determine if submission doc has the information we need and what needs to be added

Package Research

• determine how to set up a global package locally that can be run from a terminal
  • determine if this is a script we want to run or other