add readme, update run scripts

This commit is contained in:
Will Freeman
2025-01-06 15:50:05 -07:00
parent 620a3bfe02
commit 3df3ecb963
2 changed files with 44 additions and 1 deletions

41
README.md Normal file
View File

@@ -0,0 +1,41 @@
# ALPR Leaks
Log license plates, vehicle make, vehicle color, and vehicle model to a CSV along with a JPEG image of the vehicle from Motorola ALPRs exposed to the public internet.
This script is preloaded with 3 IP addresses, but more can be added.
## Running Locally
To run this project locally, follow these steps:
### Prerequisites
Make sure you have the following installed on your machine:
- [Node.js](https://nodejs.org/) (version 14 or higher)
- [npm](https://www.npmjs.com/) (version 6 or higher)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/frillweeman/alprleaks.git
```
2. Navigate to the project directory:
```sh
cd alprleaks
```
3. Install the dependencies:
```sh
npm install
```
### Running the Project
1. Compile the TypeScript files:
```sh
npm run build
```
2. Start the application:
```sh
npm start
```

View File

@@ -4,7 +4,9 @@
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc",
"start": "node src/index.js"
},
"author": "",
"license": "ISC",