Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 2.17 KB
Raw

Contributing

Below explain details for those want to contribute to this repository.

If you interested to contribute to React KL in other ways, refer to this guide.

Add page

To create a new page in this site, there are two options:

  • write React components in src/pages folder. This is Gatsby JS default behavior.
  • write MDX in src/contents folder. This is a custom behavior of this site.
    • add frontmatter to your mdx, at least the title is required.
    • file name will be used as the url of the page, e.g. code-of-conduct.mdx will be available at url /code-of-conduct.
    • the contents will be rendered with NoteTemplate component.

Run site locally

To run the site locally,

  1. clone the repository

  2. install all dependencies

    yarn

  3. start

    yarn start

Getting Data from Twitter

If the features you're developing involves gatsby-source-twitter, you need to add additional 3 keys in a .env.development file (placed next to package.json):

TWITTER_BEARER_TOKEN=<Twitter_Bearer_Token>
TWITTER_CONSUMER_KEY=<Twitter_Consumer_Key>
TWITTER_CONSUMER_SECRET=<Twitter_Consumer_Secret>

To generate the twitter tokens, you have to create an App on developer and then create a bearer token to use application authentication.

Getting Event Photos

Currently we host the meetup photos in a s3 bucket, and it requires AWS credentials to access them. Therefore if you build locally, no meetup photos will be visible but they will be shown in Netlify preview. If you need to preview the photos, request the following details from me and add them to .env.development file.

AWS_ACCESS_KEY=<Aws_Access_Key_Id>
AWS_SECRET_ACCESS=<Aws-Secret_Access_Key>