docs/readme.md
# Lottery Licence Manager Documentation
**🙏 Thank you for taking the time to read the documentation. 🙏**
The Lottery Licence Manager is a web application written by the
[City of Sault Ste. Marie](https://saultstemarie.ca/)
to meet the lottery licensing requirements of Ontario municipalities
as defined by the
[Alcohol and Gaming Commission of Ontario (AGCO)](https://www.agco.ca/).
While the application is built with Ontario municipalities in mind,
it is flexible enough to handle the lottery licensing demands of
municipalities in other jurisdictions.
## Features
- "Out of the box" support for Ontario-based bingo, raffle,
and break-open (Nevada) lottery licences.
- Flexible reporting options that meet the requirements of municipalities,
licence authorities, and inspectors.
- Open source! MIT licence! No cost to use!
## User Documentation
**[Tips and Tricks](tipsTricks.md)**<br />
Transform yourself from an average user into a power user. 🦸♀️
**[Organizations](organizations.md)**<br />
What are organizations?
How do I search organization records?
How do I maintain organization records?
**[Lottery Licences](licences.md)**<br />
How do I search lottery licence records?
How do I maintain lottery licences?
**[Lottery Events](events.md)**<br />
What are lottery events?
How do I find lottery event records?
How do I report on lottery events?
**[Locations](locations.md)**<br />
What are location records?
What are they used for?
How do I find location records?
How do I maintain location records?
## Administrator Documentation
**[Getting Started](admin-gettingStarted.md)**<br />
How to setup and start the application for the first time.
**[config.js file](admin-configJS.md)**<br />
How to use the configuration file to customize the application.
**[Logging into a New Install](admin-login.md)**<br />
How to activate the default admin user to access the application for the first time.
**[Administrator Tools - Application Settings](admin-applicationSettings.md)**<br />
Tweak some additional settings.
**[Administrator Tools - User Management](admin-userManagement.md)**<br />
How to add, update, and remove user accounts.
## More Help
Need additional help? Have a feature you would like to see implemented?
**[Reach out through the Issues area on GitHub](https://github.com/cityssm/lottery-licence-manager/issues).**
_Remember that GitHub Issues are public and can be seen by everyone._
## Helpful Links
[AGCO - Charitable Lottery Licensing Overview](https://www.agco.ca/lottery-and-gaming/charitable-lottery-licensing-overview)
[AGCO - Schedule of Approved Break Open Ticket Types and Associated Maximum Expenses](https://www.agco.ca/sites/default/files/schedule_of_approved_bot_types_and_associated_expense_maximumsen.pdf)
[AGCO - Lottery Licensing Policy Manual](https://www.agco.ca/sites/default/files/llpm_2019e.pdf)