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
- Build
- BackEnd
- FrontEnd
๐ Quick Start
yarn installto install dependencies.yarn run dev:webto start the CRA in development.yarn run serverto start the development express server.yarn run build:webbuild 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
- 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.