ticket_tracker_api

ticket_tracker_api copied to clipboard

Could you add documentation to the current README.md to:

1. Clarify if any environment or constant variables need to be set. I see references to email and AWS, but I'm not clear on what specific config variables need to be set and where.
2. Could you document on 'what' should happen if the application runs?
3. Could you document how to run the application?

`Installation

Dev environment
    To install Python dependencies, run pipenv install.
    You must have preinstalled Node.js.
    To install node dependencies, run yarn -cwd ticketscraping/js.
    If node-canvas in node_modules fails to install, please check if you have the correct prerequisite softwares installed on your machine. The detail can be found at https://github.com/Automattic/node-canvas/wiki#installation-guides based on your system.
Prod environment
    Use Dockerfile to build a container image.

August 1, 2023 Update

Reese84 code stopped working as TicketMaster implement a new anti-bot mechanism as of Aug 1. We will try to get it fixed.`

would also like to see further documentation. Cheers!