2024 WICC Workshop

Table of Contents

• Introduction
• Prerequisites
• Getting Started
• Contributions
• Deployment
• License

Introduction

This is a personal website/portfolio template used for the WICC 2024 workshop. It's built with React.

You can view the Figma file of this template here.

Prerequisites

• Node.js
• npm

Getting Started

Make sure you have Node.js and npm (or Yarn) installed on your system. You can install Node.js from the official Node.js website.

1. Fork the repository:

   • In the upper right corner of the repository page, click on the "Fork" button. This will create a copy of the repository in your GitHub account.

2. Clone the repository:

   • On your forked repository page, click on the "Code" button. This will reveal a URL. Click on the clipboard icon next to the URL to copy it.
   • Then in your terminal, navigate to the directory where you want to clone the repository.
   • Use the git clone command followed by the repository URL you copied earlier: git clone <repository-url>

3. Install Dependencies:

   • In your terminal, run npm install

4. You're done!

   • Run npm run dev to view the site!

Contributions

This project was created with contributions from:

• Design: Laura Wu
• Implementation: Dora Weng

Deployment

Follow these steps to deploy the project to Vercel:

1. Go to vercel.com.

2. Create an account:

   • Click on "Sign Up" and choose the "Hobby" plan.
   • Enter your name and email address to create your account.

3. Connect to GitHub:

   • After signing up, continue with GitHub authentication to link your GitHub account with Vercel.

4. Add a New Project:

   • Once authenticated, navigate to the dashboard.
   • Click on "Add" or "New Project" to create a new project.
   • Choose the option to import a project from your GitHub repositories.
   • Select the workshop repository from the list and grant access.

5. Customize Project Name:

   • After importing the project, you can customize the project name to your preference.

6. Deploy:

   • Once the project settings are configured, initiate the deployment process.
   • Vercel will automatically build and deploy your project based on the settings and configurations provided.

7. Access Your Deployed Application:

   • Once the deployment is complete, Vercel will provide you with a unique URL where your application is hosted. You can access your deployed application using this URL.

That's it! Your project is now deployed and accessible online via Vercel.

Usage and Attribution

You are free to use the code and resources from this repository in your projects. However, if you find them helpful and decide to use them, please provide appropriate credit by mentioning the source of the code, such as linking back to this repository or acknowledging the original authorship.

Thank you and have fun!