Skip to content

Hacktoberfest event dashboard to display issues and pull request information

License

Notifications You must be signed in to change notification settings

gusnreis/Hacktoberfest-event-dashboard

 
 

Repository files navigation

HacktoberFest 2019

Dublin HacktoberFest 2019 Dashboard

A Really cool Dashboard developed originally for the Dublin HacktoberFest.

Extensible enough to be used for different purposes - BYOL [Bring Your Own Labels] 😉

🚀 Quick start

  1. Check Prerequisites [Node, NPM & Gatsby]

    1. Install/Update Node.js LTS @ https://nodejs.org
    2. Install Gatsby CLI
      npm install -g gatsby-cli
      
  2. Fork, Clone & Dependencies [Fork, Clone & npm install]

    1. Fork the repo to you own Github alias
    2. Clone the repo into a folder
      git clone https://github.com/<this-is-you>/Hacktoberfest-event-dashboard.git
      
    3. Navigate into your new HacktoberFest-Event-Dashboard folder
      cd HacktoberFest-Event-Dashboard
      
    4. Install NPM Dependencies
      npm install
      
  3. Start developing.

    Navigate into your new site’s directory and start it up.

    npm start
    

    If you run into any issues at this stage please review the prerequisites ☝️

  4. Open the source code and start editing!

    Your site is now running at https://localhost:8000!

    Note: You'll also see a second link: https://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the HacktoberFest-Event-Dashboard directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

  8. gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.

  9. LICENSE: Gatsby is licensed under the MIT license.

  10. package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

  11. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  12. README.md: A text file containing useful reference information about your project.

About

Hacktoberfest event dashboard to display issues and pull request information

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 55.0%
  • CSS 45.0%