Skip to content

fig-x/fig-x.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About the website

Jul 6, 2024 by Fumeng Yang

This website was written in React.js + bootstrap 5 + react-gh-pages (to deploy to Github). You should be able to pull the github repository (the gh-pages branch) and then develop it locally. Each page (e.g. Home) is a *.js file. However, most of the datasets used are in the other fig-x-data repository.

Maintain

Except for the welcome text and work with us page which are embedded in the html, you should refer to fig-x-data when updating the content, including

  • News on the Home page (news.json in that repo)
  • Research area on the Research page (research.json and research folder in that repo)
  • Publication list on the Publication page (publication.json and publication folder in that repo)
  • People on the People page (people.json and people folder in that repo)
  • Artifact list on the Artifact page (artifact.json in that repo)

You shouldn't need to update this repository very much unless you need to change the style, add a feature, or add/remove a page. The code reads the jsons specified in helper.js. This design allows people without too much HTML/Javascript/React.js background to update the content. The only thing that might be annoying is that the last update date in the footer is connected to this repository.

Fumeng expects that she will be the webmaster and maintain this repository for the first few years, and eventually students should maintain this repository or rewrite it.

TODOs

  • update logo
  • add more links in the footer - no need
  • maybe add an "our friends" page (MU, VIEW, HDL, other UMD labs, etc.)
  • add UMD logo in the footer or somewhere - doesn't fit
  • the design of the Research page: one column or two-column?
  • maybe add awards in the Publication page
  • test on a larger screen (and smaller)
  • People page - sorting should distinguish postdoc, phd, master, and undergrad
  • artifact page, if the bubbles don't have the same height, it's a little urgly.

Notes

  • Currently, the research, work with us, and artifact pages all use a flyer design. It is specified in a weird way with two divs.

  • On the Research page, the small images are automatically added. The max number is 7 now. If there are more than 4 images, definitely take a look at the page. If there are more than 7 papers in an area, you need to add an entry in index.css (imagecard) and test it.

  • The icons are mostly hardcoded. If we need new icons, we need to add a line to the code. For consistency, please always use Phosphor Icons.

  • Fumeng has tested in major countries (US, China, Canada, UK, Japan, Korea, France, Germany, etc.). In China, you probably need to use a VPN because the rawgithubcontent could not load and the content does not render.

React App

This project was bootstrapped with Create React App.

Notes

  • See https://github.com/gitname/react-gh-pages for instructions on how to deploy this to Github.
  • See https://stackoverflow.com/questions/71984401/react-router-not-working-with-github-pages for routing problems.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
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.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

npm run deploy

To deploy this page to github.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published