README.md

October 27, 2019 ยท View on GitHub

โšก๏ธ hacktoberfest-website-2019

Website for Hacktoberfest event 2019 hosted by TraceCEA

https://hacktoberfest-tracecea.surge.sh


๐Ÿงฐ Tech / framework(s) used


๐Ÿš€ Quick Start

  • yarn install to install dependencies.
  • yarn run dev:web to start the CRA in development.
  • yarn run server to start the development express server.
  • yarn run build:web build the files for production.

๐ŸŒŸ Passing Environment Variables

For Client

Copy .env.sample to .env.development or .env.production in client/ directory and update credentials in those files.

For Server

Copy variables.env.sample to variables.env in server/ directory and update the file.

๐ŸŒŸ Accessing Google Sheets API

Follow instructions from here and update GSHEETS_ID, G_PKEY, G_C_EMAIL fields in server/variables.env

๐ŸŒŸ Accessing GitHub API

Generate new tokens

Goto Personal Access Tokens

  • For unauthenticated requests, the rate limit is 60 requests per hour. see Rate Limiting
๐ŸŒŸ Updating metadata

Edit config/index.js file with your custom information

๐ŸŒŸ Adding static contents

Copy contents (images, documents, etc...) to static/ directory

๐ŸŒŸ Publishing to surge.sh using GitHub Actions

Pass SURGE_DOMAIN, SURGE_LOGIN, SURGE_TOKEN to settings/secrets in GitHub Settings

๐Ÿ–ค Show your support

Give a โญ if this you find this project useful!

๐Ÿ—ž Licence

Code released under the MIT License.

๐Ÿ“‹ Copyrights

Logos & Branding:

  • ยฉ 2019 DIGITALOCEAN, LLC. ALL RIGHTS RESERVED.
  • ยฉ 2019 TRACECEA. ALL RIGHTS RESERVED.