Welcome to the DSC McMasterU Website project repository 👋
Below is a quick overview of the technologies utilized for the website. It is advisable to have a basic understanding of these technologies (at least the first 3) before making code contributions to this project. Each tool has well maintained documentation which is encouraged everyone explores.
- React - A declarative, component-based JavaScript library for building web applications
- Gatsby - A React-based, static site generator
- Tailwindcss - A utility-first CSS framework
- Firebase - Fast and secure web hosting
- netlifycms - Open source content management for Git workflows
If you are interested in our teams branching model, this blog post by Vincent Driessen does a great job of explaining gitflow.
Anyone and everyone in the DSC McMaster U Chapter is welcome to contribute to this project. Please take a moment to review the guidelines for contributing.
To start working on the site locally you must correctly setup your dev environment. To do this, please follow the instructions outlined in the guidelines for contributing document. Once you have successfully forked, cloned, and configured your repository follow the steps below to deploy the site locally.
- Navigate to the root directory and install the site dependencies:
npm install- As previously stated, The site uses the Gatsby React framework. To build and serve the site locally, you will need to install Gatsby CLI as shown below:
npm install -g gatsby-cliNote that gatsby-cli should be installed globally. For more information, see the official Gatsby CLI docs.
- You are now ready to launch the development environment by running the following npm command;
npm run develop- You can also launch the production environment by running the following npm commands;
npm run build
npm run serve