iomerkoyuncu/sparkhacks-2023

The flourish 2023 website built with React and TailwindCSS

UIC SparkHacks 2023 Website

Welcome to the UIC SparkHacks 2023 student built website! The following will show you how to get started making your first contribution!

Setting up your environment

This guide assumes you have your Github setup with an SSH key, and that you have been added to the project

You will need to install the following programs

• Git
• Node.js (Use the LTS release)

Once you have installed the above, open your terminal and execute the following commands

• git clone [email protected]:acm-uic/flourish-2023.git (You may want to clone this to your Downloads or other folder)
• cd flourish-2023
• npm install

Once you have done these steps, you are good to go!

Running the application

Running the website locally is as simple as npm start!

Making a contribution

Follow the guide in the wiki

Helper scripts

I have included some helper scripts for those of you who are new to Git

bin/prep.sh

This script prepares the Git environment for you to start your development from a fresh and up to date point.

Usage: bin/prep.sh <name-of-your-branch>

Make sure your branch name is correctly formatted, no spaces, no uppercase, dashes seperate words, and descriptive

bin/commit.sh

This script pushes your latest changes to your branch and prepares it for a pull request.

Usage: bin/commit.sh

If it is your first push it will give you a link to create a pull request. Click that link and create the pull request.

This script will likely open your editor asking for input. Put the title of the PR in the first line, and the description in the second line. (Hint: If your default is VIM or VI, use :wq to exit)

Contributors

Christian Bingman - @ChristianBingman

Julius Linus - @rapterjet2004

Eduardo Morales - @emoral435

Connor Hunter - @Mohpann

Preet Talati -Ptalat2

Tony Chan - @tchan2003

Marko Bogosavljevic - @ThatMarko

David Mei - @ChangerEX

Jeongjae Park - @Jeongjae-0124

Yurii Koval - ykoval201

Jimmy Cgen - jjmmyc

Ron Pham - @Bacoburn

Adrian Knight - @Ajknight121

Ares Stavropoulos - @Ares1605

Steven Trumblay - @kaodik

Luke Hartzell - @LukeHartzell1

Lei Chen - @flypoodles

Sam E - @dejazzhands