Skip to content

Latest commit

 

History

History
155 lines (104 loc) · 5.11 KB

DEVELOPMENT_AND_BUILD.md

File metadata and controls

155 lines (104 loc) · 5.11 KB
Raw

Prerequisites

  • Go 1.23
  • Node.js 18+ and npm

Build

1. Web

  1. Build the web interface using the following command:

    npm run build

  2. After the build process is complete, a new out directory will be created inside seanime-web.

  3. Move the contents of the out directory to a new web directory at the root of the project.

2. Server

Build the server using the following command:

  1. Windows (System Tray):

    Set the environment variable CGO_ENABLED=1

    go build -o seanime.exe -trimpath -ldflags="-s -w -H=windowsgui -extldflags '-static'"

  2. Windows (No System Tray):

    This version is used by the desktop app for Windows.

    go build -o seanime.exe -trimpath -ldflags="-s -w" -tags=nosystray

  3. Linux, macOS:

    go build -o seanime -trimpath -ldflags="-s -w"

Note that the web interface should be built first before building the server.

Development

  1. To get started, you must be familiar with Go and React.

  2. I recommend creating a dummy AniList account to use for testing. This will prevent the tests from affecting your actual account.

Server

  1. Create/choose a dummy data directory for testing. This will prevent the server from writing to your actual data directory.

  2. Create a dummy web folder if you want to develop the web interface too or build the web interface first and move the contents to a web directory at the root of the project before running the server. Either way, a web directory should be present at the root of the project.

  3. Run this command to start the server:

    go run main.go --datadir="path/to/datadir"

  4. Change the port in the config.toml located in the test data directory to 43000. The web interface will connect to this port during development. Change the host to 0.0.0.0 to allow connections from other devices.

  5. The server will start on http://127.0.0.1:43000.

Web

  1. Run the web interface:

    # get to web directory
cd seanime-web
# install dependencies
npm install
# run the next.js dev server
npm run dev

    Go to http://127.0.0.1:43210 to access the web interface.

During development, the web interface is served by the Next.js development server instead of the Go server, leading to different ports.

Handlers & Codegen

The following points are very important for understanding the codebase.

  • All routes are declared in internal/handlers/routes.go where a handler method is passed to each route.
  • Route handlers are defined in internal/handlers.
  • The comments above each route handler declaration is a form of documentation similar to OpenAPI
  • These comments allow the internal code generator (codegen/main.go) to generate endpoint objects & types for the client.
  • Types for the frontend are auto-generated in seanime-web/api/generated/types.ts, seanime-web/api/generated/endpoint.types.ts, seanime-web/api/generated/hooks_template.ts based on the comments above route handlers and all public Go structs.

Run the go generate command at the top of codegen/main.go to generate the necessary types for the frontend. This should be done each time you make changes to the route handlers or structs that are used in the frontend.

AniList GraphQL API

The following points are for understanding the AniList API integration.

Anilist queries are defined in internal/anilist/queries/*.graphql and generated using gqlgenc.

Run this when you make changes to the GraphQL schema.

go get github.com/Yamashou/gqlgenc
cd internal/api/anilist
go run github.com/Yamashou/gqlgenc
cd ../../..
go mod tidy

  • gqlgenc will generate the different queries, mutations and structs associated with the AniList API and the queries we defined. These are located in internal/api/anilist/client_gen.go.

  • In internal/api/anilist/client.go, we manually reimplements the different queries and mutations into a ClientWrapper struct and a MockClientWrapper for testing. This is done to avoid using the generated code directly in the business logic. It also allows us to mock the AniList API for testing.

Tests

Do not run the tests all at once. Run them individually if you have to.

You should:

  • Create a dummy AniList account and grab the access token (from the browser).
  • Edit the test/config.toml file with the access token and the username. Use config.example.toml as a template.

Tests are run using the test_utils package. It provides a InitTestProvider method that initializes the test config global variable. This global variable contains the values from the test/config.toml file. Functions passed to InitTestProvider skip the test if the corresponding flag is not enabled in the test/config.toml file.

func (t *testing.T) {
	test_utils.InitTestProvider(t, test_utils.Anilist())
}

Testing third-party apps

Some tests will directly interact with third-party apps such as Transmission and qBittorrent. You should have them installed and running on your machine. Edit the test/config.toml file and individual tests to match your setup (e.g. port, password, files to open, etc.)