circleciB npmVersionB npmDownloadsB dependenciesB greenkeeperB

codeclimateB coverageB codeissuesB doccoverageB styleB

If you aren't familiar with CLI (command line interface) programs you should check the video tutorial.
If you are, just keep reading.

You must have node installed to use this (version >= 8)

Install with

npm install -g sincding

And then just run

sincding # Run full program
sincding sync # Update files quickly

On the first run you will be prompted for credentials

• username: Your uc username without @uc
• password: Your uc password
• path: The absolute path to the folder where you want to download the siding folders and files
• ignore: Space separated acronyms of courses you don't want to download. Usefull for those who are assistants. (example: IIC2154 IIC1103)

The credentials are stored in your Home directory on .sincding/data.json

Let's see it in action

demo

Follow this script

git clone https://github.com/open-source-uc/sincding.git # Clone the repo
cd sincding # Cd into directory
yarn # Install dependencies

Run tests

yarn test

Run program

yarn start # Run from project folder
npm link # Link it
sincding # Run from anywhere

In order for tests to pass you must create a .env.json file in ./__tests__ like this

{
 "username": "YOUR_UC_USERNAME",
 "password": "YOUR_UC_PASSWORD"
}

Check the contributing guide