Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.46 KB

File metadata and controls

73 lines (47 loc) · 2.46 KB

Creativity and Search Project - Frontend (Typescript)

* This project is refactored based on jercymat/creativity-and-search-frontend using Typescript, implementing strong type and replacing legacy Redux with Redux-toolkit for easier maintenance and lesser boilerplate code.

This project served as the Frontend web application of Creativity and Search Project hosted by Prof. Soo Young Rieh, School of Information, The University of Texas at Austin. The application is bootstrapped with Create React App and developed with React, with various state management libraries like Redux and Redux-saga to build a scalable and robust web application.

The result of this project has been published at ACM SIGIR Conference on Human Information Interaction and Retrieval (CHIIR) 2023.

Get Started

Prerequisites

  • Node.js
  • NPM
  • Typescript
  • React
  • SASS
  • React-router-dom
  • Redux, React-redux, Redux-Saga
  • Axios

Running the Service

To start the service locally:

npm install
npm start

It will run the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Documentation

Build

Run the following code:

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.
After the build, the app is ready to be deployed.

See the section about deployment for more information.

Deployment

After the build, pack the /build folder and serve index.html with website hosting software like Nginx or Apache HTTP Server

Static Server

For quick deployment, the easiest way to handle this would be to install serve and let it handle the rest:

npm install -g serve
serve -s build

The last command shown above will serve your static site on the port 3000.

Other Solutions

For other deployment solutions, check here for mre detail.