Source code behind the development of the SchulichHub created by the Engineering Students' Society. This project creates a platform for engineering students at the University of Calgary to share, discuss, and initiate technical projects. The SchulichHub aims to connect individuals across departments in order to better experiential learning initiatives from the ESS.
Link to live website: hub.essucalgary.com
Ensure that you have Docker and docker-compose
installed on your development computer: Docker website. Windows computers will need to use WSL2 (Windows Subsystem for Linux) as a backend following this guide.
# Clone this repo
git clone https://github.com/ess-uofc/ess-schulichhub.git
cd ess-schulichhub
# Start development server
yarn dev
To quit the development environment, simply press Ctrl+C and the Docker container will shut down.
Ensure that you have the standard Node.js development tools available to use and the Yarn Package Manager installed globally.
To develop or run this repository locally:
# Clone this repo
git clone https://github.com/ess-uofc/ess-schulichhub.git
cd ess-schulichhub
# Install dependencies
yarn install
# Start development server
ionic serve
Pull requests are welcome. Please use semantic commit messages and branch naming conventions using this guide. Private branches should be named using the semantic/name/purpose
convention. For example: docs/ratik/update-readme
signifies that Ratik is responsible for this documentation change and the purpose of the branch is to update the README. For major changes, please open an issue first to discuss what you would like to change. Please base all pull requests off of the main branch as they will be rebase merged. Before opening a pull request: check that there are no linter issues by running yarn run lint-check
and fix all formatting using yarn run prettier-fix
. The linear history requirement is enforced on main.
Please make sure to update tests as appropriate.