Code Monkey home page Code Monkey logo

global's Introduction

Hack Club Global Websites

The goal of this project is to enable the creation of simplified versions of our Hack Club site that are translated into global languages. These sites should require practically no maintenance and be very brief. An example is hackclub.es.

This site uses Next.js' internationalization and middleware features. MDX is used for content and Theme UI for styling.

Sites

Adding a Site

  1. Create a new MDX file in the pages/copy directory. The name of the file should be the ISO 639-1 code for the language you intend to write the site in. For example, if I was adding a Portuguese site I would create a pages/copy/pt.mdx file.

  2. Add content to the MDX file. Base this off of the content on the Spanish site (view it at pages/copy/es.mdx). It should contain: a headline such as "By the students, for the students", a sentence long description of Hack Club and then a large button pointing to the English site.

  3. Edit the locales field in next.config.js to include the ISO 639-1 code of your language.

  4. Add your domain to the domains field in next.config.js following the format below. Unless we have acquired a special domain for the site you are adding, use a .hackclub.com subdomain.

    {
      domain: 'jp.hackclub.com',
      defaultLocale: 'jp',
      http: true
    }

    a. If you're using a .hackclub.com subdomain, submit a PR to hackclub/dns to add your .hackclub.com subdomain. Add a record to hackclub.yaml in the following format:

    SUBDOMAIN_NAME:
      - ttl: 1
        type: CNAME
        value: cname.vercel-dns.com.
  5. Make a PR to this repo! The maintainers will support you in setting up the domain for hosting.

Reach out to @sampoder on Slack if you need any support. Thank you for your help!

global's People

Contributors

ayan-biswas0412 avatar cfanoulis avatar dependabot[bot] avatar dubiels avatar erdem85 avatar exu3 avatar itsimpeccable avatar itsmingjie avatar javizaleta avatar karanchoudhxry avatar leecheeyong avatar lucifer25x avatar ni5arga avatar odysseuskir avatar sampoder avatar syedhuzaifa007 avatar taylorylee avatar toonnongaeoy avatar wollygfx 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.