diff --git a/Frontend-Draft/README.md b/Frontend-Draft/README.md index 1d04663..b28b04f 100644 --- a/Frontend-Draft/README.md +++ b/Frontend-Draft/README.md @@ -1,48 +1,3 @@ -# Anima Project -Welcome! This project has been automatically generated by [Anima](https://animaapp.com/). -## Getting started -> **Prerequisites:** -> The following steps require [NodeJS](https://nodejs.org/en/) to be installed on your system, so please -> install it beforehand if you haven't already. - -To get started with your project, you'll first need to install the dependencies with: - -``` -npm install -``` - -Then, you'll be able to run a development version of the project with: - -``` -npm run dev -``` - -After a few seconds, your project should be accessible at the address -[http://localhost:1234/](http://localhost:1234/) - - -If you are satisfied with the result, you can finally build the project for release with: - -``` -npm run build -``` - -## Storybook - -After installing, you can view your storybook by running: - -``` -npm run storybook -``` - -After a few seconds, your storybook should be accessible at the address -[http://localhost:6006/](http://localhost:6006/) - -You can build your storybook for release with: - -``` -npm run build-storybook -``` diff --git a/Frontend-Draft/src/screens/SearchPage/SearchPage.jsx b/Frontend-Draft/src/screens/SearchPage/SearchPage.jsx index 008e584..a2187d5 100644 --- a/Frontend-Draft/src/screens/SearchPage/SearchPage.jsx +++ b/Frontend-Draft/src/screens/SearchPage/SearchPage.jsx @@ -59,12 +59,7 @@ export const SearchPage = () => { const [value, setValue] = React.useState([0, 31284837]); - const handleChange = (event, newValue) => { - setValue(newValue); - }; - function valuetext(value) { - return `${value}°C`; - } + diff --git a/README.md b/README.md index 1abc105..6868db8 100644 --- a/README.md +++ b/README.md @@ -46,5 +46,44 @@ the openai_chatbot code runs a Flask server, it first authenticates requests by If the GPUs are found to power it one way of implementing some open source model like Llama from HuggingFace with Python's transformers and using something like SocketIO to make a client server connection between wherever the GPUs are and the feedback VM. # Frontend +> **Prerequisites:** +> The following steps require [NodeJS](https://nodejs.org/en/) to be installed on your system, so please +> install it beforehand if you haven't already. + +To get started with your project, you'll first need to install the dependencies with: + +``` +npm install +``` + +Then, you'll be able to run a development version of the project with: + +``` +npm run dev +``` + +After a few seconds, your project should be accessible at the address +[http://localhost:1234/](http://localhost:1234/) + + +If you are satisfied with the result, you can finally build the project for release with: + +``` +npm run build +``` + +## Overview of Frontend Structure: +Each screen is contained within a folder in /screens/, along with its stylings in style.css +The search page uses two functions in order to implement its filter search: +> UseEffect: this is called when the page is loaded, and fills the datasets with all of the datasets in the database +> searchFunction: this is called whenever the button "submit filters" is pressed, and applies the filters on the database, + showing only the datasets that are valid. This function is also called in UseEffect if we did a quicksearch, right after the dataset is filled up. + +> We have the filters: Oldest Date, Keywords (AND selection/Or Selection), Language, # of Rows, and a search bar, which will search the datasets description and name for the exact text written in the search bar. + + +> clicking on a dataset frame will popup a modal that has the description of that dataset, and a button to the webpage currently holding the dataset. +> Bootstrap was used a lot in the development of the Search Page. If anyone wanted to change or develop the search page, it is advised that they have at least a basic understanding of bootstrap, and react. +