Code Monkey home page Code Monkey logo

code423n4.com's Introduction

Register as a warden

Registering as a warden allows you to be listed on our leaderboard. You'll need to register your handle in order to submit a bug for a contest.

To register as a warden, follow the instructions in the C4 docs.


C4 website

  • Built with Gatsby
  • Hosted on Netlify
  • Auto-deploys on merge to main
  • Site content and data editable on GitHub

Editing content

  • Site pages are found in the ๐Ÿ“ content folder.
  • Content is editable via GitHub pull request or Netlify CMS.
  • If creating a new page in GitHub, note the frontmatter on other page files.
  • Page urls are built based on the slug field in frontmatter.

Site data is found in ๐Ÿ“ data subfolders:

  • ๐Ÿ“ contests
  • ๐Ÿ“ findings
  • ๐Ÿ“ handles
  • ๐Ÿ“ orgs
  • ๐Ÿ“ pages
  • ๐Ÿ“ reports

Note that handles allows for us to have team data as well as individual people.

Note there are data relationships to be maintained.

Setup (for external contributors)

Fork code-423n4/code423n4.com and clone your fork.

Create accounts (optional):

  • mailgun.com
  • kickbox.com
  • netlify.com
  • moralis.io

Add environment configuration

Required

  • Generate GitHub [personal access token] with(https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with "full control of private repositories" scope and set GITHUB_TOKEN
  • Use your GitHub username for GITHUB_REPO_OWNER
  • Set GITHUB_CONTEST_REPO_OWNER to code-423n4
  • Set NODE_ENV to development
  • Use BRANCH_NAME from .env.sample OR optionally set it to whichever branch you are developing
  • Use REPO from .env.sample OR optionally name your repo something else and update it here
  • Use GATSBY_MORALIS_APP_ID and GATSBY_MORALIS_SERVER from .env.sample OR optionally set up your own moralis server and use the server url and app id from your instance. See instructions in documentation/MoralisInstructions.md

Optional (to enable email confirmation features)

  • Use your email address for EMAIL_SENDER
  • Use mailgun private api-key for MAILGUN_KEY
  • Use custom or default domain from mailgun for MAILGUN_DOMAIN
  • Generate a kickbox API key and set KICKBOX_API_KEY

Create repos (optional)

In order to test applying for a judge role, create a repo named judges

If you submit test findings to the default test contest repo, you can find your submissions here. Be aware: this is a public repo.

If you would rather create your own test contest and findings repo(s), make sure to add them to _test-data/contests/contests.csv and update the CONTEST_GITHUB_REPO_OWNER variable.

Develop

yarn
yarn start

NOTE: To complete registration of new users, you'll need to merge PRs for warden registrations into your forked repo and then pull the changes.

Design

Legacy CSS is in src/styles Going forward, create scss modules for any new components in src/components

code423n4.com's People

Contributors

code423n4 avatar kartoonjoy avatar itsmetechjay avatar samuselderg avatar liveactionllama avatar joshuashort avatar cloudellie avatar captainmangoc4 avatar ninek9 avatar simon-busch avatar sockdrawermoney avatar 0xsorrynotsorry avatar dianaperkinsdesign avatar sksb2180 avatar dstaley avatar snasps avatar zscole avatar hannahtuttle avatar adamavenir avatar loudoguno avatar brockelmore avatar eugenioclrc avatar burgertime-c4 avatar thevrintern avatar mon-1 avatar norswap avatar marvinkruse avatar felixjosemon avatar axic avatar adeshkolte avatar

Stargazers

Kavita B avatar HLABZยฎ 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.