Skip to content
This repository has been archived by the owner. It is now read-only.
hyperlog.Club is a community for newcoming programmers
JavaScript CSS
Branch: master
Clone or download

README.md

hyperlog.Club

A community for newcoming programmers to learn new programming languages and leverage the power of resources.

🚀 Quick start

  1. Clone the Repo

    Clone the given repo in a folder where you want to.

    git clone https://github.com/BrainBuzzer/hyperlog.Club
  2. Install the Dependencies

    Navigate to the cloned directory and install the dependencies required to run the project.

    cd hyperlog.Club
    npm install

    Note: You may need to install windows_build_tools and node-gyp if you are using Windows OS.

  3. Start developing.

    Spin up the server from the directory.

    npm run develop
  4. Open the source code and start editing!

    Hyperlog.Club is now running at http://localhost:8000!

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

    Open the hyperlog.Club directory in your code editor of choice. Happy Coding!

🧐 What's inside?

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

.
├── node_modules
├── src
├── resources
├── .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. /resources: This directory contains all the tutorials and resources that you can find on the website. This directory is the core of all resources.

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

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

  6. 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.

  7. 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).

  8. 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.

  9. 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.

  10. LICENSE: Hyperlog.Club is licensed under GPL-v3.

  11. 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).

  12. 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.

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

FOSSA Status

You can’t perform that action at this time.