Giter Club home page Giter Club logo

bugs-nyu.github.io's Introduction

This is the website for BUGS, NYU's premier open source club

Contents

How to Contribute

For adding markdown Events

  1. Fork this repository
  2. Make a new markdown (filename ending with .md) document in the "_events" folder of your fork
  3. Follow the template event by including this at the top with the correct information:
---
layout: event
title: "Your Event Title"
event_date: 2017-12-31
time: "Event Time"
location: "Event Location"
---
  1. Then include the entire event description in markdown using this guide for help. No need to write your title, date, time, or location, they're automatically added to the event page for you
  2. Make a pull request to the original repository

For adding markdown News posts

  1. Fork this repository
  2. Make a new markdown (filename ending with .md) document in the "_posts" folder of your fork
  3. Follow the template post by including this at the top with the correct information:
---
layout: post
title: "Your Post Title"
date: 2017-12-31
---
  1. Then include the entire news post description in markdown using this guide for help. No need to write your title or date, they're automatically added to the news post page for you. Add a time and location if applicable
  2. Make a pull request to the original repository

For larger Contributions

  1. Fork this repository
  2. Make your fork live through your GitHub Pages domain
  • If you don't already have GitHub Pages, set it up by following this guide
  • In your forked repository, go into the Settings > to the GitHub Pages section > and change Source from "None" to "master branch" like so: contribute1
  • Go to the file "_config.yml" contribute2 and change baseurl and url to your GitHub Pages settings like so: contribute3
  1. Make any changes you want
  2. When you are ready to make a pull request, you should make a new branch and revert the "_config.yml" file to its original form in this new branch
  3. Make a pull request from your new branch, while keeping your master branch live on your GitHub Pages for reviewers to study before merging your pull request. In your pull request description, please include a link to the live master branch on your GitHub Pages

What to Contribute

Ongoing Needs

  • Make markdown files for upcoming BUGS events, including:
    • General club meetings
    • Small group project meetings
  • Make markdown files for news stories related to open source, including:
    • General news about BUGS
    • Interesting open source projects outside of BUGS
    • Interesting tech news related to open source
    • Etc

Planned Features

  • Display all student contributors
  • Add more project details
    • Display To Do's
    • Display student contributors
    • IRC/Discord
  • Add IRC Client
    • Link to Discord
    • Info on how to setup your own client

How to use Jekyll

Installing Jekyll

GNU/Linux and MacOS

If you're running GNU/Linux or MacOS on your system check if you have Ruby version 2.2.5 or above and RubyGems installed on your system.

Ruby - https://www.ruby-lang.org/en/downloads/

RubyGems - https://rubygems.org/pages/download

Run gem install jekyll once you have RubyGems installed on your system to install Jekyll.

Windows

If you're running windows take a look at this guide: https://jekyllrb.com/docs/windows/#installation

Using Jekyll

To start a development server run jekyll serve in the project source folder. The the server will run at http://localhost:4000

Resources for Jekyll syntax and usage:

bugs-nyu.github.io's People

Contributors

a1liu avatar anandithaaa avatar bradleybrecher avatar cr4zyafrican avatar esilverm avatar georgema-web avatar joannakl avatar keys248 avatar owura82 avatar s1mb10t3 avatar sameertulshyan avatar swapnilkha avatar thefifthisa avatar

Watchers

 avatar

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.