The official incursion waitlist for The Ditanian Fleet, Eve Online's premier armour HQ incursion community. Features include ESI fleet invites, skill checking, fit checking, a doctrine page, and community guides.
Report bugs by opening a GitHub issue, or send a message to a TDF HQ FC. Security issues should be reported to an FC directly.
If you have a change you would like to implement, have a talk with the FC team first. After we've had a chat, if you choose to go ahead, please develop your code on your own fork.
Once your feature is ready, check that everything still works. Ensure that the UI and server still compile and interact with the components of the website that you've changed, to make sure they work as expected, then you can open a pull request.
Pull requests should include:
- A short title that describes the change (e.g., Added readme /w installation instructions)
- An optional description that provides more context (if applicable), including any mandatory actions that other developers will need to undertake (e.g., Drop and recreate the Announcments table. The sql/sqllite.sql file has been updated to include the new schema).
We will review your pull request and let you know what happens.
👍🎉 Thanks for taking the time to contribute! 🎉👍
We recommend you use WSL for development as it simplifies working with the backend
code. This readme is written using Ubuntu but it should cover the basics for most Linux distros, if you haven't got WSL setup see Installing WSL | Microsoft Docs.
Visual Studio Code users can use the plugin Remote - WSL to edit code inside of WSL from their native windows VS Code install.
Check that nodejs, npm, sqlite3, and cargo are installed on your system:
sudo apt install nodejs npm sqlite3 cargo
Register an Eve Swagger API application at https://developers.eveonline.com with an eligible player account.
Setting | Value |
---|---|
Callback URL | http://localhost:3000/auth/cb |
Scopes | publicData esi-skills.read_skills.v1 esi-clones.read_implants.v1 esi-fleets.read_fleet.v1 esi-fleets.write_fleet.v1 esi-ui.open_window.v1 esi-search.search_structures.v1 |
* Valid account: You will need to agree to the Developer License Agreement. Your account must have a valid credit card that has been used to pay for at least one month of Omega.
** Never share your secret key, commit it to a repo, or make it public!
The Waitlist has three services (see below). Before starting the front end, both the back end and SSE server should be running.
Service Name | Language | Purpose |
---|---|---|
backend/ |
Rust | Handles business logic, ESI and database calls, and provides an API for the front end. |
frontend/ |
JavaScript (React) | Provides a UI that consumes the API provided by the backend. |
the-ditanian-fleet/sse-server |
Rust | A service that broadcasts server driven events to UI clients |
- Clone the repo
the-ditanian-fleet/sse-server
- Build a Docker image
- Generate a secret key using
openssl rand -hex 32
and copy it somewhere safe. This key is needed to start the SSE server and the backend process - Start the docker image. You must pass the secret key from step three as an environment variable called
SSE_SECRET
CLI Prompts
git clone https://github.com/the-ditanian-fleet/sse-server
docker build . -t tdf/sse
openssl rand -hex 32
docker run --env SSE_SECRET=<secret> tdf/sse
- Navigate to the
backend/
directory - Create a config.toml file and populate the environment variables:
- Use
openssl rand -hex 32
to generate a new apptoken_secret
- ESI
client_id
andclient_secret
values come from step 2 - SSE
secret
should be the same as theSSE_SECRET
used when launching the SSE server
- Use
- Run the
shrink-sde.sh
script - Create a sqlite database called
waitlist.sqlite
- Copy the SQL queries from
sql/sqlite.sql
into the sqlite3 terminal and execute them - Set environment variables using export:
DATABASE_ENGINE=sqlite
andDATABASE_URL=${DATABASE_ENGINE}:./waitlist.sqlite
- Compile the code using
cargo build --release --no-default-features --features=${DATABASE_ENGINE}
- Run the server
- Run the frontend (see section below)
- Click on login and complete the SSO workflow with at least one character
- Insert a record in the
admin
table to give yourselfcouncil
permissions - Navigate to the Fleet page and "ESI re-auth as FC"
CLI Prompts
# Setup app (steps 1-3)
cd backend/
cp config.example.toml config.toml & nano config.toml
sh shrink-sde.sh
# Setup Database (step 4-5)
sqlite3 waitlist.sqlite < sql/sqlite.sql`
# Start backend (step 6-8)
export DATABASE_ENGINE=sqlite
export DATABASE_URL=sqlite:./waitlist.sqlite
cargo build --release --no-default-features --features=sqlite
cargo run
# Now build and run frontend in a separate shell (step 9, also see section below)
# Final things (step 10-12)
sqlite3 waitlist.sqlite
INSERT INTO admin (character_id, role, granted_at, granted_by_id)
SELECT
id AS character_id,
'council' AS role,
CURRENT_TIMESTAMP AS granted_at,
id AS granted_by_id
FROM character WHERE name = 'YOUR CHARACTER NAME';
## Quit the shell using Ctrl+D
- Navigate to the
frontend/
directory - Install NPM dependencies
- Build the React Code
- Start the server
CLI Prompts
cd frontend/
npm install
npm run build
npm run start