Written in React and deployed using Vercel. We use a Gatsby boilerplate that compiles into static assets for deployment.
First and foremost, make sure you have Node installed.
git clone https://github.com/HackBeanpot/website-2021 Clone into this repository.
cd website-2021 CD into the new local repo.
npm install Install dependencies.
npm install --global gatsby-cli Install Gatsby
gatsby develop Launch a hot-reloading dev environment to see the site running on your local!
The branch master is where our uncompiled production code lives. Whenever a new commit is made here, CI notices and builds everything inside into static assets which are then committed to the branch gh-pages and deployed. In general, don't commit directly to master or branch out of it.
The branch gh-pages is where our compiled (static) code lives. This branch is LIVE. LIVE I SAY. So we leave it up to our CI robots to manage it. Unless you know what you are doing, probably don't branch, merge, or commit to this branch.
The branch develop is our main branch. Branch off of here if you are starting a new feature; merge back into here if you are ready for that feature to go to prod. We'll periodically merge changes in this branch into the master branch.
All other branches are probably used for developing things. When you make one, try to give it a descriptive name!
Once your PR is approved, select the squash and merge option. Commits can be merged unsquashed if you feel that they are meaningful (ie if they each fulfill their own purpose). The goal is to keep the commit history organized so that it is easy to find when certain changes are made. Remember to delete your personal branches after merging to keep the repo clean.
DO NOT SQUASH COMMITS WHEN MERGING INTO MASTER!! This messes with the source history.
New pages will be added to the src/pages folder, which also represents the url of each page. Each folder x in the pages folder will correspond to the url path .../x, which will render the index.jsx file for that path.
Shared components belong in the src/components folder, and ones that are unique to certain pages can go in a components subdirectory of that page.
Jsonified data to be loaded into page content should be saved under src/data.
Spaces, not tabs. Each "tab" is 2 spaces. And try to keep to 80 char lines.
We use Prettier for code styling. If you are using Visual Studio Code, install the prettier extension. In your user settings, add the line "editor.formatOnSave": true to automatically format files when you save them. Alternatively, run the format script npm run format before opening a PR.
Components, props and state should be named with CapitalizedCamelCase. Variables are camelCased. File names, folder names, and CSS classes should be in dash-separated-lowercase.
Import absolute paths rather than relative paths when possible (for subfolders of src).
Don't. We have CI.
But the command to do so is gatsby build in the repo's top-level directory. Keep in mind that if you do build on your local and then view the static files, links between pages won't work. Better to use gatsby develop to see the changes you're working on.
- React - JavaScript library for building user interfaces or UI components
- Gatsby - React-based web framework
- Prettier - Used to auto-format code
- Material Design Icons - Used to insert icons (Search for icons here)
- GraphQL - Natively integrated with Gatsby, used to query data for our projects directory.
Under the src directory…
- Components - Defines components that will be used in multiple places or throughout the website (like the header or footer).
- Data - Contains any data that will be used to render elements. GraphQL is configured to automatically fetch data from this folder. For example, names and descriptions of projects are stored in a JSON file in /src/data and used to render project cards on the project page.
- Images - Contains all image files
- Pages - Contains a folder for each page of the website and defines the layout of the pages.
- Styles - Contains the majority of our CSS. Styles should be defined here (as opposed to using in-line CSS or defining it in a “styles” section in the HTML) as much as possible.