Giter VIP home page Giter VIP logo

commit-generator's Introduction

Commit Generator!

*** UNDER CONSTRUCTION! COME BACK SOON! ***

Commit generator is used to create automated commits made to your GitHub in order to decorate your commit history with pixel art.

Description

All in all, the commit generator is a cron job that is ran in the AWS cloud using a CloudWatch rule to schedule the execution of a Lambda function that commits code to a GitHub account. Since the cronjob is ran in the cloud, it will execute as often as you assign it.

Technologies Used

  • AWS
    • Lambda
    • CloudWatch
    • IAM
  • Node.js
  • Git
  • NPM
  • Bash

Prerequesites

  1. Git installed.
    • Be sure you have Git installed on your machine. If you are unsure, run the following command in your terminal to check.
git --version
  1. Node installed.
    • If you have Node installed, then go download Node here. If you are unsure, run the following command in your terminal to check.
node --version
  1. AWS account.

Getting started

  1. Fork repository

  2. Clone repository.

    • Clone the repository, install all the dependencies from the package.json, and then change directories into new repository.
    git clone <GITHUB_URL>
    npm install
    cd commit-generator
  3. Zip node modules

    • We will be importing all of the dependencies, for our Lambda function, as a Lambda layer. This will keep the size of our Lambda function small enough to edit the code inline in the Lambda console. From the root of the repository's directory, run the following:
    npm install
    mkdir nodejs
    mv node_modules nodejs/
    zip -r nodejs.zip nodejs
    rm -rf nodejs

    If the execution is correct, it should have created a new zip file for our Lambda layer, nodejs.zip.

    NOTE: The directory name nodejs is not random. It will point our Lambda layer to the node_modules folder when we upload it to AWS.

Create Lambda function

Create Lambda layer

Create CloudWatch Rule

commit-generator's People

Contributors

josephiznot avatar

Watchers

 avatar  avatar

Forkers

notjoeandy

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.