Mbrlla Hacks Website

The website for Mbrlla Hacks | A student-run hackathon
Check out the website

View Issues · Pull Request

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing

Built With

• React.js
• Bootstrap
• React-Bootstrap

(back to top)

Getting Started

How to set up the website locally

Prerequisites

Install the following:

• npm

  npm install --force

  The --force flag is for temporarily solving issues with react versions
• git

  https://git-scm.com/downloads

Installation

1. Clone the repo with HTTPS

   git clone https://github.com/MbrllaHacks/Website.git

   or with SSH

   git clone git@github.com:MbrllaHacks/Website.git

2. Install NPM packages

   npm install --force

   The --force flag is for solving an react issue

(back to top)

Usage

How to run the website in developer mode

1. Use the npm scripts

   npm start

2. Open http://localhost:3000 to view it in your browser

The page will reload when you make changes. You may also see any lint errors in the console.

(back to top)

Contributing

You can contribute to this project by fixing issues. If you aren't sure on where to get started, take a look at the ones with the good first issue label

See the open issues for a full list of proposed features (and known issues).

1. Clone the repository locally by doing git clone [repository url].

2. For any change, create a new branch (1st and 2nd screenshots) in the repository with form [name]/[description] (i.e. micha/add-footer).

3. git pull in your local repository.

4. git checkout [branch name] using the name of the branch you just created.

5. Make changes to the code.

6. git add [file(s)] to stage the changes for commit (use git add . to add all changes).

7. git commit -m "[message describing changes]" to create a commit for the added changes.

8. git push to update the remote (GitHub) with the new changes.

9. Create a new pull request from your branch to main. If the change is associated with an issue, type Closes #[issue number] to reference that issue and automatically close it when the PR is merged.

10. Wait for approval, then merge.

(back to top)