Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 2.1 KB

README.md

File metadata and controls

56 lines (33 loc) · 2.1 KB
Raw

brickhack.io

Build

The public facing website for BrickHack.

Registration + management site: hackathon_manager

Getting Started

Code environment

Ensure you have Git set up and SSH access to GitHub. If you have Git but not SSH, you can clone using the HTTPS url, but you'll have to type in your GitHub credentials every time.

We use ParcelJS and SASS (the SCSS variant) to build the mostly-static site. Where needed, FontAwesome and possibly React are peppered in.

Cloning the directory

$ git clone https://github.com/codeRIT/brickhack.io.git
$ cd brickhack.io

Installing dependencies

$ npm install

Running the application

$ npm run dev

You should then be able to access the site at localhost:1234.

Environment variables

The images in the gallery are hosted on our AWS S3 instance.

GitHub Actions (our CI/CD) uses a repository secret to store the environment variable.

For local development on the gallery:

  • Create a .env file in the root of the project
  • Add IDENTITY_POOL_ID="key" to the top, where key is the AWS IAM key.

Note: Ask the Engineering team lead (@peterkos) for an AWS key if you do not have one.

Development & Deployment

All development work should be done locally in a new branch and/or fork. Then, make a pull request to have the code merged into the develop branch. Once the develop branch gets to a good state, it gets merged into the master branch for a production deployment.

Code pushed to any codeRIT/brickhack.io branch will automatically build on Travis CI for tests. Any build on the master or develop branch will also trigger a deploy to GitHub Pages or our staging Dokku instance respectively.

(Note that we are currently converting to CircleCI, and if possible, GitHub Actions.)