Code Monkey home page Code Monkey logo

hacktoberfest's Introduction

Hacktoberfest

A little web app for tracking participation in the devICT Hacktoberfest event.

Participate

Make Wichita a better place through code. Hop on over to the devICT Hacktoberfest app and register with your GitHub profile.

Development

Follow the steps below to get the app running locally on your system.

Installation

Download & install Docker on your system.

Create an application from your GitHub Settings page. Set the Homepage URL to http://localhost:8080 and Authorization callback URL to http://localhost:8080/auth/github.

Copy the secret.env.example file and rename it to secret.env:

cp secret.env.example secret.env

Paste the Client ID and Client Secret from your registered GitHub application into secret.env.

(If on Windows) Make sure your local repository path (for example C:\Users\username\repos\job-board) is available for Docker Filesharing by going to Docker Dashboard > Settings > Resources > File Sharing

Start the database in daemon mode:

docker compose up -d db

Start the web service:

docker compose up --build web

Install frontend assets:

npm install

Build the frontend assets:

npm run build

You're ready to go! Visit localhost:8080 in your browser.

Developing Locally

Using the configured Docker Compose file if you edit anything under public/ or templates/ then the change will be available immediately. If you change any .go files you will have to rebuild the image. While the web service is running press ctrl + c to cancel the process and then run docker-compose up --build web again to restart.

Running npm run watch will watch for frontend changes and rebuild CSS assets.

This website uses the Typicons icon library. Download the SVG files from their website.

Credit

The entire idea and name "Hacktoberfest" comes from the Digital Ocean event by the same name.

hacktoberfest's People

Contributors

aaronarduino avatar aayushborkar14 avatar blunket avatar chrisl8 avatar cjanzen avatar cjprieb avatar dependabot[bot] avatar hitjim avatar imacrayon avatar jameskupke avatar jcbwlkr avatar joestrouth1 avatar katherinemichel avatar kentonh avatar m-zubairahmed avatar samanthakem avatar sarthakroy2002 avatar sethetter avatar southekal avatar tedkriwiel avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

hacktoberfest's Issues

Improve sponsor images

Some of the sponsor images look grainy or possibly stretched. Find better replacements possibly SVG files.

Add logos

We should add logos of participating organizations

  • devICT
  • Ennovar
  • The Labor Party
  • MakeICT
  • Open Wichita
  • Start Up Wichita

Unable to log-in

Both https://devict-hacktoberfest.herokuapp.com/ as well as the docker-compose build report an error after repeatedly making request to the account.

  • secret.env file is created
  • Error on webpage This application has made an unusually high number of requests to access your account. Please reauthorize the application to continue.
  • Error from terminal (Docker container) web_1 | 2017/10/15 06:42:40 auth.go:54: securecookie: the value is too long

Improve mobile styling

The site has some usability ssues on mobile. Do a full review and fix what you find. Be sure to document what you changed in the PR description. If you aren't sure about something go ahead and comment here.

Fix list styling

There are a few places on the home page where we have unordered lists of text. They look weird because the bullets are way off on the left. Find something that looks better

Update checkPRs to count 2 commits as valid

Background:

  • devICT's 2019 hacktoberfest requires 2 qualifying commits to be eligible for a set of stickers (requirement is different from the previous year where 4 commits were needed).

Issue:

Fix:

  • update the javascript to count 2 commits as valid instead of 4

Pull back open issues from repos whose status is active/true

Problem:

  • When you look for Open Issues, you will find that issues brought back includes orgs and projectswho have been set to False in the Go map hash defined in main.go.

Example of a org/project set to False

Fix:

  • We only want to display Open Issues from orgs and projects who have a status True

Add benblankley/fort-rpg to list of approved projects

I don't actually think this repository contributes to the public good of our fair city.

This is just a shameless attempt to get a t-shirt.

The repository is owned by a devICT member who lives in Wichita though.

Incorrect date used to display PRs.

The following two sections of code are using the datetime when the page is loaded as the datetime for all of the PRs when displaying them. This makes it appear as if all the PRs were done at the same time.

File: templates/profile.tmpl

<div id="pr-template-valid">
  <div class="alert alert-success">
    <p><i class="fa fa-check-circle"></i> <span class="title"></span></p>
    <p>Opened against <span class="repo"></span> on <span class="date"></span></p>
  </div>
</div>

<div id="pr-template-invalid">
  <div class="alert alert-danger">
    <p><i class="fa fa-exclamation-circle"></i> <span class="title"></span></p>
    <p>Opened against <span class="repo"></span> on <span class="date"></span></p>
    <p><small>This PR is not against an approved project or organization. If
      you feel it should qualify please <a href="https://github.com/devict/hacktoberfest/issues/new">file an
      issue</a>.</small></p>
  </div>
</div>

Allow "sponsors" section display to be easily turned on/off

Background:

  • For the 2019 devICT Hacktoberfest, there wasn't enough time to arrange for sponsors and sponsorship.
  • Will be nice to be able to turn on/off all information around sponsors/sponsorship rather than having to delete/comment out code related to it.

Steps to replicate

  • Sign in with your GitHub account from the devICT Hacktoberfest! account.
  • This should log you into the profile page (/profile)
  • Observe that there is a modal that shows up that talks about Sponsorship as well as the existence of a checkbox to share you details with Sponsors.
    Sponsor checkbox
  • Ideally, would like to turn on/off display regarding Sponsors/Sponsorship.

Make defining number of qualifying commits/gifts flexible

Background:

  • for the 2019 devICT hacktoberfest event, we changed the number of qualifying commits to be eligible for a devICT sponsored gift from 4 to 2. We also changed the gift from a tee shirt to a set of stickers for 2019.

Problem:

  • Visit devICT hacktoberfest website!
  • Observe that there are several areas across the website where we mention the number of qualifying commits and gifts.
    • note: this also includes areas such as meta description, twitter:description
  • This makes it hard to identify all areas across templates that needs to be updated if we change the nature of qualifying commits/prizes offered.

Probable Solution:

  • Eg: create a md/json file from where the data can be read.
  • Create the data once and use everywhere else 🎉

Style the profile page

Once you log in we show your captured info and give you some helpful tools. That page is super basic looking. At a minimum we should use our chosen color palette.

Install Dependancies

So for a total noob like me I'm not sur what the line to install the dependences mean. I'm guessing It's to install yarn but I'm not sure what or where to do that.

Wichitalks PRs not counting

https://devict-hacktoberfest.herokuapp.com says PRs against https://github.com/wichitalks count for the Wichita-based Hacktoberfest, but when I check my status, the following error message is generated:

Fixed Issue #56
Opened 2016-10-08T17:45:45Z against Wichitalks/wichitalks.github.io
This PR does not count for the Wichita Hacktoberfest because it is not against an approved project or organization. If you feel it should be then please file an issue.

Can we please fix so the Wichitalks PRs count? Thanks!

Integrate with github issues

Add an api endpoint /api/issues that hits github for open issues in all of our target orgs and projects then shows it to the user.
Only show open issues with the tag "hacktoberfest".
This should be on the profile page so we can use their token.
Look at the available information and decide what fields are appropriate to show the user. We might want to make additional calls to get information about each project.
The code in prs.go and profile.js should be a good starting point.

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.