Giter Club home page Giter Club logo

rubyforgood.org's Introduction

Ruby for Good New Website

Welcome Contributors!

We love open source contributors! Feel free to take on open issues that are marked help wanted or open new issues. Please comment on the issue to be assigned to work on it as well as if you need more clarification. You can also reach out to @meg-gutshall via the Ruby for Good Slack.

When submitting your pull request, please submit to the dev branch as this is our working branch.

Getting Started

Fork this repository and clone it down to your computer. Create a new branch that describes what you're working on. Then, run bundle install and npm install to make sure you have all the gems and packages you need.

We built this site using Jekyll and it's hosted via GitHub pages. We used Ruby with Bundler on the initial build and have since added NodeJS. We've included dot files that support both rbenv (.ruby-version) and asdf (.tool-versions) ruby managers for your convenience.

Tool Versioning

  • Ruby 2.7.1
  • Bundler 2.1.4
  • NodeJS 16.1.0
  • NPM 7.22.0

Useful Commands

To run the website locally, type npm run test in your terminal and navigate to http://127.0.0.1:4000/ to see the site in your browser. A reload will be triggered every time you change the code in you editor.

We have also implemented some tools that check the files for syntax issues and autocorrect them whenever possible. These are called linters and they will automatically check any files you have staged for a commit.

If you'd like to lint your code before you stage it, you can do so with the following commands:

npm run lint        // Lints all files (i.e. corrects them syntactically for this codebase)
npm run lint:js     // Applies to JS files only
npm run lint:style  // Applies to CSS and SCSS files only
npm run lint:text   // Applies to Markdown files only
npm run prettier    // Formats and styles all files

You will not be able to successfully commit your work until all errors are cleared.

Going Deeper

Please see our newly created Ruby for Good Website Wiki to learn more about the project! Content will be continually added there. Also keep an eye out for project boards in the future!

rubyforgood.org's People

Contributors

ababich avatar arielj avatar craigjz avatar fionadl avatar giacoelho avatar grazirs avatar leoactionz avatar meg-gutshall avatar onerinas avatar pollygee avatar seanmarcia avatar teezzan 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.