xuliu15 / webapp

Web App

This is a functional web applicaiton that has several features:

1. Submit a reading.
2. Display the factorials of all readings ordered by timestamp.
3. Automatically generate ID to readings.
4. Search all submissions by the reading.

The backend is built with FastAPI and the frontend is built with React, partly following the tutorial by Eric Roby (https://www.youtube.com/watch?v=0zb2kohYZIM).

How to run the app

Note: Following steps are only tested on Mac.

1. clone the repository

git clone https://github.com/xuliu15/webapp.git

2. Set up virtual environment

Go to cd webapp

Then python3 -m venv myenv

3. Activate virtual environment

source myenv/bin/activate

4. Install packages

pip install -r requirements.txt

5. Activate backend

Go to cd FastAPI

Then run uvicorn main:app --reload, click the http link to see backend.

6. Activate frontend

Open a new terminal

Go to cd webapp/React/webapp

In case of sh: react-scripts: command not found, install a pacakge npm install react-scripts

Then run npm start , a webpage will automatically open.

How to run unit test

Open the folder webapp in VScode

Go to path cd FastAPI

Then run python3 -m unittest