This is a message from the developer for those who are using or considering deploying this application. Please view it here.
evacuate
is a TypeScript application that monitors seismic activity and posts earthquake information to a specified service. The application connects to a WebSocket API to receive earthquake data, processes this information, and posts it with relevant details using the AT Protocol API.
- Connects to a WebSocket API to receive earthquake data.
- Processes seismic intensity and event codes.
- Posts formatted earthquake information to a service using the AT Protocol API.
- Node.js (version 20 or higher)
- pnpm (version 9 or higher)
-
Clone the repository:
git clone https://github.com/evacuate/evacuate.git
-
Navigate to the project directory:
cd evacuate
-
Install dependencies:
pnpm install
-
Copy the example configuration file:
cp .env.example .env
-
Edit the
.env
file
-
Build: Compile the TypeScript files to JavaScript
pnpm build
-
Development: Run the application in development mode with live reloading
pnpm dev
-
Lint Code: Lint code
pnpm lint
-
Ensure your
.env
file is correctly configured. -
Run the application:
pnpm start
-
The application will log in to the AT Protocol service and establish a WebSocket connection. It will then listen for earthquake data and post relevant information when an event is detected.
Contributions Welcome! You can contribute in the following ways.
- Create an issue - propose a new feature. Report a bug
- Pull Request - Fix a bug or typo Refactoring the code
- Share - Share your thoughts on blogs, Twitter, etc.
For more details, see docs/CONTRIBUTING.md.
I proposed, facilitated, and developed the entire project.
- Minagishl (@minagishl)
This project is licensed under the MIT License. See the LICENSE file for details.