{"id":18406381,"url":"https://github.com/blakeguilloud/ganon","last_synced_at":"2025-04-05T16:03:19.338Z","repository":{"id":20245855,"uuid":"83898904","full_name":"BlakeGuilloud/ganon","owner":"BlakeGuilloud","description":"A javascript library","archived":false,"fork":false,"pushed_at":"2022-12-06T20:39:52.000Z","size":986,"stargazers_count":93,"open_issues_count":37,"forks_count":196,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T21:47:23.301Z","etag":null,"topics":["hacktoberfest","javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BlakeGuilloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-04T14:24:34.000Z","updated_at":"2023-12-22T12:12:10.000Z","dependencies_parsed_at":"2022-08-07T10:15:19.007Z","dependency_job_id":null,"html_url":"https://github.com/BlakeGuilloud/ganon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlakeGuilloud%2Fganon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlakeGuilloud%2Fganon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlakeGuilloud%2Fganon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlakeGuilloud%2Fganon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlakeGuilloud","download_url":"https://codeload.github.com/BlakeGuilloud/ganon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361614,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","javascript"],"created_at":"2024-11-06T03:08:45.294Z","updated_at":"2025-04-05T16:03:19.301Z","avatar_url":"https://github.com/BlakeGuilloud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Logo\" src=\"./logo/ganon_version_2.png\" /\u003e\n\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Ganon is a javascript library designed and maintained by open source contributors.\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://travis-ci.org/BlakeGuilloud/ganon\"\u003e\n    \u003cimg alt=\"Build Status\" src=\"https://travis-ci.org/BlakeGuilloud/ganon.svg?branch=master\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ganon\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/ganon.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/BlakeGuilloud/ganon/blob/master/LICENS\"\u003e\n    \u003cimg alt=\"License\" src=\"https://img.shields.io/npm/l/ganon.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.org/package/ganon\"\u003e\n    \u003cimg alt=\"Downloads\" src=\"http://img.shields.io/npm/dt/ganon.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- [![Build Status](https://travis-ci.org/BlakeGuilloud/ganon.svg?branch=master)](https://travis-ci.org/BlakeGuilloud/ganon) [![NPM version](https://img.shields.io/npm/v/ganon.svg)](https://www.npmjs.com/package/ganon) [![License](https://img.shields.io/npm/l/ganon.svg)](https://github.com/BlakeGuilloud/ganon/blob/master/LICENSE)\n[![npm module downloads](http://img.shields.io/npm/dt/ganon.svg)](https://www.npmjs.org/package/ganon)\n--\u003e\n\n\n\u003cbr /\u003e\n\n### A HUGE THANKS!!\nA very special thanks to [@csleong98](https://github.com/csleong98) for designing our logo!\n\n\nHuge props to [@andreasgruenh](https://github.com/andreasgruenh) and [@ktilcu](https://github.com/ktilcu) for helping collaborate.\n\nAnd the biggest of credit goes to all of our awesome [Contributors](https://github.com/BlakeGuilloud/ganon/graphs/contributors)!!\n\n### Usage\n```bash\n$ yarn add ganon\n```\n\nNodeJS\n```javascript\n// import { sum } from 'ganon';\nconst { sum } = require('ganon');\n\nconst sumOfOneAndTwo = sum(1, 2);\n=\u003e 3\n```\n\nJavascript\n```javascript\n// import sum from 'ganon/dist/sum';\nconst sum = require('ganon/dist/sum');\n\nconst sumOfOneAndTwo = sum(1, 2);\n=\u003e 3\n```\n\n### Objective\nTo build a suite of javascript methods by the time [hacktoberfest](https://hacktoberfest.digitalocean.com/) ends! Let's get some T-shirts!!\n\nGanon is designed to get as many people involved as possible, so our objective here is to fix or improve an existing method and then write the skeleton of a desired method for someone else to build. In the spirit of getting everyone involved, please only fix one or two methods at a time and make sure to push up something for someone else to work on!\n\nThis project was created to have fun.\n\n### Project Structure\nAll methods will live in the `lib` directory of the project. They should be written as [methodName].js, required and exported in `lib/index.js`.\n\nAll tests will live in the `test` directory. A test file should be formatted `[methodName].test.js` to reflect what method is being tested.\n\n### Contributing\nPlease read our [Contributing Guide](https://github.com/BlakeGuilloud/ganon/blob/master/CONTRIBUTING.md) for information on how to contribute to this project! All skill levels are more than welcome to participate in this project!\n\n### Demo\nWe're going to walk through the process of taking on an issue, resolving it, writing a new issue, and shipping some code.\n\nThe method we are going to resolve is called `sum`:\n\n```javascript\n// lib/sum.js\n\nfunction sum(a, b) {\n// Your code goes here.\n}\n\nmodule.exports = sum;\n```\n\nIn order to test this method, we will first run `yarn test sum`:\n\n```bash\n$ yarn test sum\n\n  FAIL  problems/sum.test.js\n    ✕ adds 1 + 2 to equal 3 (8ms)\n    ✕ adds 3 + 4 to equal 7 (1ms)\n\n    ● adds 1 + 2 to equal 3\n\n      expect(received).toBe(expected)\n\n      Expected value to be (using ===):\n        3\n      Received:\n        undefined\n```\n\nAs you can see, there is something wrong with the function sum, so let's resolve it:\n\n```javascript\n// lib/sum.js\n\nfunction sum(a, b) {\n  return a + b;\n}\n\nmodule.exports = sum;\n```\n\nRun the test again:\n\n```bash\n$ yarn test sum\n\n  PASS  problems/sum.test.js\n    ✓ adds 1 + 2 to equal 3 (6ms)\n    ✓ adds 3 + 4 to equal 7 (1ms)\n```\n\nNow that I have fixed the sum function to return the desired value, I need to write the skeleton of a new method for other contributors to work on. Let's write one called `difference`:\n\n```javascript\n// lib/difference.js\n\n// Write a function that returns the difference of the first two parameters\n\nfunction difference(a, b) {\n// Your code goes here.\n}\n\nmodule.exports = difference;\n```\n\nWe will need to accompany this method with a test(s) to ensure it returns the proper value:\n\n```javascript\n// test/difference.test.js\n\nconst { difference } = require(\"../lib\");\n\ndescribe(\"difference\", () =\u003e {\n  test(\"subtracts 1 - 3 to equal -2\", () =\u003e {\n    expect(difference(1, 3)).toBe(-2);\n  });\n\n  test(\"subtracts 10 - 3 to equal 7\", () =\u003e {\n    expect(difference(10, 3)).toBe(7);\n  });\n});\n\n```\n\nNow that we have fixed a method, written the skeleton of a new method, and a test to accompany it, we can push up our changes and open a pull request. :fire: :fire: :fire:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblakeguilloud%2Fganon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblakeguilloud%2Fganon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblakeguilloud%2Fganon/lists"}