Commit a3a2344f authored by Daniel Van Den Hoven's avatar Daniel Van Den Hoven
Browse files

Update README.md

parent 505509c0
To run the CLI, enter the CLI directory and run ./client.py in the terminal to start the query.
The CLI is an infinite loop until the command quit is entered.
US Election Group 17
Members : Eugene Lu and Daniel van den Hoven
Pre-Requisites for running it are
1. pip install mysql-connector-python
2. pip install python-dotenv
3. Update .env to enter your credentials in where DB_USER represents username for Marmoset3 and DB_PASS represents password to login to Marmoset3.
1. `pip install mysql-connector-python`
2. `pip install python-dotenv`
3. Update .env to enter your credentials in where `DB_USER` represents username for Marmoset4 and `DB_PASS` represents password to login to Marmoset4 and `DB_NAME` represents the name of the database you wish to connect to.
Under the db folder, run the file `create_tables.sql` to setup the relational model for the tables for our project.
Then run `python3 ./import_data.py` to insert the relevant data into the database.
To run the CLI, enter the CLI directory and run `./client.py` in the terminal to start the query.
The CLI is an infinite loop until the command quit is entered. A good place to start to understand
the CLI is to run help or to view our video.
CLI Test Cases are shown under `CLI/TestCases` which represent the tests run to maintain integrity of our client.
Full details of test plan can be viewed under the doc.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment