https://github.com/tdjsnelling/edalerts
Create Elite Dangerous commodity market alerts. Get notified when a specific commodity buys or sells above or below a certain value.
https://github.com/tdjsnelling/edalerts
Last synced: 10 months ago
JSON representation
Create Elite Dangerous commodity market alerts. Get notified when a specific commodity buys or sells above or below a certain value.
- Host: GitHub
- URL: https://github.com/tdjsnelling/edalerts
- Owner: tdjsnelling
- Created: 2020-07-19T20:11:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-26T16:03:27.000Z (11 months ago)
- Last Synced: 2025-02-26T17:21:59.955Z (11 months ago)
- Language: JavaScript
- Homepage: https://edalerts.app
- Size: 3.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# edalerts
Create Elite Dangerous commodity market alerts. Get notified when a specific commodity buys or sells above or below a certain value.
## Deployment
There are 4 components:
1. **Web front-end** – the interface used to create/delete alerts
2. **API** – receives requests from the web interface and saves changes to the database
3. **Market listener** – listents to the EDDN and sends alerts based on incoming market messages
4. **MongoDB** – database
### Web front-end
Can be started from the `site` directory with `yarn build` & `yarn start`
Requires the `NEXT_PUBLIC_API_BASE` environment variable containing the URL on which the API service is reachable, e.g. `http://localhost:3000`.
### API & market listener
Can be started from the `api` directory with `yarn start` & `yarn listen` respectively. There are also Dockerfiles for both services.
Both services require the `MONGO_URL` environment variable.
## Resources
* [Commodity lists](https://github.com/EDCD/FDevIDs)
* [Station list](https://eddb.io/api)