-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This wiki is to help newcomers who are interested in helping develop our website get started.
Our website is built using ReactJS and Bootstrap as the primary front-end frameworks, and all of the sources are compiled using Gulp. If you are unfamiliar with any of these, we highly recommend checking out some tutorials/explanations before diving in.
- Official ReactJS tutorial
- CodeCademy tutorial
- LearnCode.academy ReactJS video series
- Bootstrap container and layout overview
- Bootstrap components
- React-Bootstrap library tutorial (This is once you have an idea of how Bootstrap is used, and overrides the regular Bootstrap components)
Once you are ready to start development on the website you will need to install NodeJS and yarn. Here are the following commands to install them based on your operating system:
Operating System | Command |
---|---|
Mac | ? |
Linux (Arch) | sudo pacman -S nodejs yarn |
Windows | ? |
Once they are installed, make sure that you have the most up-to-date version of NodeJS by executing the following:
yarn global add n
sudo n stable
Finally, clone the repo, cd
to its directory, and run the following two commands:
yarn
yarn start
This will install all dependencies for the project, build it, serve it to your default browser, and listen for changes to any of the development files. When any changes are detected, it will automatically rebuild the changed files. If you install the LiveReload extension for your browser, then it will even automatically reload the changes in your browser!