diff --git a/.gitignore b/.gitignore index 2175bd6..02c4164 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ -*README.md *venv/ __pycache__/ *.pyc diff --git a/README.md b/README.md new file mode 100644 index 0000000..dcee5c4 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# 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). +``` \ No newline at end of file