https://github.com/iaincollins/ardent-www
Web based interface for the Ardent API and Ardent Collector which stores data submitted to the Elite Dangerous Data Network
https://github.com/iaincollins/ardent-www
eddn elite-dangerous elitedangerous
Last synced: 4 months ago
JSON representation
Web based interface for the Ardent API and Ardent Collector which stores data submitted to the Elite Dangerous Data Network
- Host: GitHub
- URL: https://github.com/iaincollins/ardent-www
- Owner: iaincollins
- License: agpl-3.0
- Created: 2023-06-12T02:33:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-13T11:29:09.000Z (6 months ago)
- Last Synced: 2025-12-15T01:09:12.153Z (6 months ago)
- Topics: eddn, elite-dangerous, elitedangerous
- Language: JavaScript
- Homepage: https://ardent-insight.com
- Size: 9.37 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# Ardent Website
This is the website for [ardent-insight.com](https://ardent-insight.com)
Ardent provides trade and exploration data for the game
[Elite Dangerous](https://www.elitedangerous.com/).
It uses a live data feed from the
[Elite: Dangerous Data Network](https://eddn.edcd.io) by the
[Elite: Dangerous Community Developers](https://edcd.github.io/).
Related repositories:
* https://github.com/iaincollins/ardent-api
* https://github.com/iaincollins/ardent-collector
* https://github.com/iaincollins/ardent-auth
## Getting started
### Starting in production mode
Dependencies are installed and the site run in production mode in the usual
way for a Node.js application with a build step:
npm install
npm run build
npm run start
It is a good idea to test all builds in production mode after being in
development mode as there can be some differences in behaviour, in particular
relating to how CSS behaves after assets are build for production.
### Starting in development mode
Dependencies are installed and the site run in development mode in the usual
way for a Node.js application:
npm install
npm run dev
This will start a web server running on port `3000` in development mode with
hot reloading enabled, the site will connect to the live API. This is useful
for testing with real world data without needing to have a full copy of the
databsases locally, but is limited as sign in will not work in this mode.
Note: You may sometimes see CORS requests failing locally in the browser as a
side effect of running the site on localhost while making calls to the
production API URL. These errors can be safely ignored.
### Starting the full stack in development mode
You can run the full stack consisting of
[ardent-www](https://github.com/iaincollins/ardent-www),
[ardent-api](https://github.com/iaincollins/ardent-api),
[ardent-collector](https://github.com/iaincollins/ardent-collector) and
[ardent-auth](https://github.com/iaincollins/ardent-auth) locally by starting
all of them using `npm run dev:local` which will start each service running on
port `3000`, `3001`, `3002` and `3003` respectively.
Being able to run the full stack locally, including authentication, requires
configuration of appropriate auth tokens using environment variables or an
`ardent.config` file.
For authentication to work, you will, at a mimium, need to configure the
following details, with the `AUTH_CLIENT_ID` option corresponding to the
Client ID (with AUTH and CAPI scope) that you have configured in the
[Frontier Developer Zone](https://user.frontierstore.net/developer).
AUTH_CLIENT_ID=
ARDENT_AUTH_JWT_SECRET=
ARDENT_SESSION_SECRET=
If you create a file called `ardent.config` in the parent directory for
the repositories - or create a file at `/etc/ardent.config` - with environment
variables in this format all the services will use any supported configuration
options specified there.
If you want to download real data to test with, you can run `npm run download`
in the `ardent-collector` respository to fetch the last backup, this make take
a few hours.
## Credits
_This software would not be possible without work from dozens of enthusiasts
and hundreds of open source contributors._
Special thanks to Elite Dangerous Community Developers members, Elite
Dangerous Data Network maintainers, Anthor (Elite Dangerous Star Map)
and Gareth Harper (Spansh).
Thank you to all those who have created and supported libraries on which this
software depends and to Frontier Developments plc for supporting third party
tools.
## Legal
Copyright Iain Collins, 2024.
This software has been released under the GNU Affero General Public License.
Elite Dangerous is copyright Frontier Developments plc. This software is
not endorsed by nor reflects the views or opinions of Frontier Developments and
no employee of Frontier Developments was involved in the making of it.