jz-lu / personal-website

final-project-spring-2024-redefining-the-stem-portfolio created by GitHub Classroom

Final Project (Redefining the STEM Portfolio)

Description

The purpose of this project is to redefine what it means to have a portfolio website in the STEM field. While many academics might argue that content is all that counts, I argue that at the end of the day, we are all humans and we like to look and interact with nice-looking things, including nice intuitive websites.

Project Documentation

• CM523 Final Project Guidelines & Schedule
• Final code demo: Here is the link to my website.
• Add any links to wireframes, mockups, your presentation, etc. here in a list so it is easy for you to find later.

How to Use This Repository

Make sure you've set up your development environment. Then, use the following commands to get up and running!

Command	Description
npm install	Installs dependencies
npm run start	Start development. Edit your code in the src folder.
npm run lint	Checks all code for formatting and validation errors.
npm run fix	Checks all code for formatting and validation errors and attempts to automatically fix them.
npm run test	Runs autograding, which will check for linting, formatting, and that you have updated all placeholder content.
npm run build	Create a production-ready build of your code to the dist folder.
npm run deploy	Builds and deploys your code to Github Pages.

Development Cheat Sheet

What you want to do	Steps to take	When to do it
Set up the project	Clone this repository Open Terminal, cd to your project folder, and run npm install Run npm run start to test things out!	Just once, when you start the project
Write new code	Decide what you want to add to the code. For example, you might want to add styles for a map. Try to keep it focused! Create a branch to help keep this code separate from team members' code. Navigate to your project in terminal and run npm run start to start coding! Commit your changes frequently. Multiple commits are encouraged!	Each time you want to add a new feature
Share your code or get feedback	Make sure you've committed your changes. Make sure you've created a branch! If you didn't, don't worry - that's fixable too. Push your branch up to Github. Open a pull request. Don't forget to assign yourself, and request a review from your team members in your Slack channel. If it's in progress, you can mark it as a draft.	As soon as you're ready for feedback! Earlier is better.
Merge your code	Make sure you've opened a pull request and asked for a code review from someone on your team. Once it's approved, you're ready to merge! Hit the big green button. Delete your branch on Github. Don't worry, you can always get it back! Delete your local branch in Tower if you like. This helps keeps things clean.	When it's feeling good and stable!
Deploy your code (make it live)!	Make sure you've merged your code! Switch to the main branch in Tower. Make sure to pull in updates so you have the latest code. Navigate to your project in terminal, and then run npm run deploy. In 15 minutes or so, you should see an update on Github Pages! The URL will be https://professorkolodziej.github.io/final-project-spring-2024-redefining-the-stem-portfolio/. Sometimes, it takes less time.	When you're ready to show your work to the world, or for a class check in!

Credits

This project is based on the Student Site Boilerplate Template. Check out the documentation for more information on prerequisites for using this repository.

Browser Support

• Chrome (latest)
• Edge (latest)
• Firefox (latest)
• Internet Explorer Edge
• Opera (latest)
• Safari (latest)