mirror of
https://github.com/FoggedLens/alprleaks.git
synced 2026-02-12 14:32:44 +00:00
add readme, update run scripts
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal 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
|
||||
```
|
||||
@@ -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",
|
||||
|
||||
Reference in New Issue
Block a user