Git Product home page Git Product logo

community's Introduction

All Contributors

Gatsby ❤️ Dai

Community at Maker

The Maker Foundation Community Development team began with a mandate to directly foster the growth of the MakerDAO ecosystem by focusing on our community’s most motivated members. We launched a series of initiatives that encouraged people to participate in, and contribute to, the success of the Dai Stablecoin. With the dissolution of the Maker Foundation and Community Development, these programs are now sunset and archived. Anyone interested in learning more about the programs can visit Archives tag in the Community repo.

One of the Community Development projects is the community portal, a community developed resource, built and maintained by MakerDAO community members. Below are instructions on getting started with the portal, which is built with Gatsby and DAI UI.

Portal

🚀 Setting Up Local Environments

We've built this as a Theme-UI Gatsby starter for projects that will use Dai-UI theme kits.

See the official Dai-UI repo for more in-depth information.

  1. Clone

    git clone https://github.com/makerdao/community.git
  2. Install dai-ui-theme-maker and dai-ui-icons are pre-installed. This project makes use of yarn. You'll likely need to use npm to get everything setup once cloned.

    # This project makes use of yarn.
    yarn

    PREREQUISITES: You need to have these dependencies installed before the "yarn" command. ○ https://brew.sh/https://nodejs.org/en/https://yarnpkg.com/

  3. Start

     yarn start
  4. Open the source code and start editing!

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

    Note: You'll also see a second link: http://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.

🧐 What's inside?

A quick look at some important files and directories you'll see in this project.

.
├── node_modules
├── src
|    ├── gatsby-plugin-theme-ui
|    ├── images
|    ├── modules
|    └── pages
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

Important Directories

  1. src/gatsby-plugin-theme-ui: This directory contains all files that will be consumed by the gatsby-plugin-theme-ui on build and provided to components through context. For more info see their docs.

  2. src/modules: This directory is the mirror image of a components folder. Except it's organized by contextual focused. You can find all your ui related components in the ui folder.

Gatsby Usual Suspects

  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.

❤️ Made with Love

Dai-UI - MakerDAO's Dai-UI Team

This Starter - @Maximum_Crash and @andytudhope

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Réjon Taylor-Foster

💻 🎨 💡

Amy Jung

🎨 📖 🚧 🧑‍🏫 👀 💵 📆 🧑‍🏫 📹

Davidutro

📖 🖋 📆 🤔 🧑‍🏫 👀 📢 📹

Anna Alexa

📝 🖋 📖 🤔 🧑‍🏫 📆 💬

Tim Black

📖 🚧 🧑‍🏫 👀 🐛 💻 📆

shea-fitz

🎨

LongForWisdom

💼 📆 💬 🤔 📢 📖

prose11

🖋 📖 🚧

Artem Isios Gordon

🖋 🤔 👀

Seth Goldfarb

📝 🖋 🐛 🤔 👀 📖

Richard Brown

🐛 🖋 📖 💵 🚧 🧑‍🏫 📆 📹 👀

Aaron Anderson

📖 🐛 💻

TomDeMichele

📝 🖋 🐛 🤔

isaacpearl

💻

Be Fit Sandpiper

💻

Alex Singh

🔧 🐛 💻

Andrew Burban

🖋 🚧 📆

Andy Tudhope

📖 🐛 🎨 🔧 💻

Dennis Mitchell

🖋

Gala Guillén

🖋 🌍

Hadassah Damien

💡 📋 🤔 📢

Hayden Sander

📖 🖋 🤔

anatta

🖋 📖 🤔

Jerry Goldfarb

🔊 📝 🖋 📖 🤔 🚧 📆 💬

Jose Ferrari

🖋

Josiah

🐛 💻 🚇 🔧

Juan Guillen

💼 📋 🤔 📆 💬 🌍 📹

Kevin Wildenradt

🤔 📆 💻

Marcin Jagodzinski

🌍 💬 📹

Mario Ferrari

💬 🚧

Nazzareno Massari

💻 🚇 🐛

Pavel Korecky

🖋

Richard Rosa

🎨

Scott Herren

💻 🐛

blimpa

🖋 📖 🚧 📹 📆

Elihu

🖋 📖 🚧 📆 🤔

Sai Teja

🖋

This project follows the all-contributors specification. Contributions of any kind welcome!

community's People

Contributors

longforwisdom avatar ghettodev avatar prose11 avatar davidutro avatar richatghettodev avatar twblack88 avatar reuptaken avatar maximumcrash avatar andersonmmi avatar kwadraxx avatar ultraschuppi avatar amy-jung avatar tyler17 avatar blimpa avatar 0xelihu avatar kodiakhq[bot] avatar cpstl avatar juan-fintech avatar hexonaut avatar aburban90 avatar ahbartsch avatar dependabot[bot] avatar derek-flossman avatar lamboshinakaghini avatar jparklev avatar jiecut42 avatar goldfarbas avatar andytudhope avatar annaalexakr avatar monet-supply avatar

Watchers

James Cloos 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.