Plotter_App/README.md

28 lines
1.0 KiB
Markdown
Raw Normal View History

2025-08-19 17:07:55 +01:00
# Setting up
## Step 1:
### Backend setup
* Use __"cd Quote_Manager_server"__
* to open server folder.
* Use __"python3 -m venv env_name" or "python -m venv env_name"__
* to create environment.
* Use __(bash) "source env_name/bin/activate" or (cmd) "env_name\Scripts\activate.bat"__ to
* activate environment.
* Use __"pip install -r requirements.txt"__ to install needed libraries
* Use __"uvicorn api_main:app --reload"__ to start app
* or __"uvicorn api_main:app --reload --port (enter port number)"__ only if you want to use a
* different port from 8000.
## All contents are in the root folder.
## Step 2:
### Frontend Setup
* Use __"cd quote_plotter_client"__ to open vite folder.
* Use __"npm install"__ to install all dependencies.
* use __"npm run dev"__ to start app.
## Editable contents are in:
```
src/components/(chartComponents.tsx, dropDownComponents.tsx, tableComponents.tsx(only if needed, else delete)),
src/context(querycontent.tsx),
src/QueryOptions(apiQueryOptions.tsx, dataTypes.tsx).
```