Skip to content

VideoAlligator/video-search-frontend

Repository files navigation

Video Search Tool (frontend)

A React App with Typescript

The goal of this project is to develop an accessible web page with a video frame searching engine powered by object detection and scene detection machine learning models.

Prerequisite

Make sure npm (package manager) is installed.

If you are using VS Code, please install Prettier and ESLint extenstions. It's necessary for automated lint and code style.

Change the local env variable in .env file to local/cloud database. Copy .env.example to your own .env. To test with local API, REACT_APP_API_BASE is http://localhost:8080. To use the production environment API, just change it to https://video-segment-search-api.herokuapp.com/.

Setup

This project was bootstrapped with Create React App.

  1. npm install: Install all packages

  2. npm start: Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

Other Available Scripts

npm test: Launches the test runner in the interactive watch mode.

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.

Deployment

Use the main branch to deploy: git push heroku main, deploy to Heroku.

Learn More

  1. React documentation

  2. Typescript documentation

  3. Material-UI

  4. styled-components

  5. Redux, React Redux

  6. React Router

  7. ESLint and Prettier

About

A React App with Typescript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published