An open API service indexing awesome lists of open source software.

https://github.com/innei/processreportercli


https://github.com/innei/processreportercli

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Process Reporter Cli for Windows

Process Reporter Cli is a windows cli. It is designed to report in real time the name of the foreground application being used by the current user on windows.

## Related projects

- [ProcessReporterMac](https://github.com/mx-space/ProcessReporterMac)

## Before you start

You need to install [Node.js](https://nodejs.org/en/) and yarn.

## Environment

Before you start, you need to create a `.env` file in the root directory of the project. The file should contain the following environment variables:

```env
# reporter key
UPDATE_KEY=
# api url
API_URL=

# aws S3 key
S3_ACCESS_KEY=
S3_SECRET_KEY=
```

## Config

And after save your env file, then you can edit `./src/configs.ts`, to set your own configurations.

## Run it

For development, you can run the following commands:

```bash
yarn install --ignore-engines
yarn run dev
```

For production

```bash
yarn install --ignore-engines
yarn run build
cd dist
## before your run it, you need to check your env file is in the dist directory
node index.js
```

## License

2024 Innei, MIT