docs: 📝 Misskey -> Firefish in documentation/comments/WebAuthn name

This commit is contained in:
ThatOneCalculator 2023-10-19 17:01:02 -07:00
parent cc27ba1dbe
commit 53949b668a
No known key found for this signature in database
GPG Key ID: 8703CACD01000000
7 changed files with 17 additions and 24 deletions

View File

@ -94,9 +94,9 @@ An actual domain will be assigned so you can test the federation.
- The tag name must be the version - The tag name must be the version
## Development ## Development
During development, it is useful to use the `yarn dev` command. During development, it is useful to use the `pnpm run dev` command.
This command monitors the server-side and client-side source files and automatically builds them if they are modified. This command monitors the server-side and client-side source files and automatically builds them if they are modified.
In addition, it will also automatically start the Misskey server process. In addition, it will also automatically start the Firefish server process.
## Testing ## Testing
- Test codes are located in [`/test`](/test). - Test codes are located in [`/test`](/test).
@ -119,20 +119,13 @@ yarn test
#### Run specify test #### Run specify test
``` ```
TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" yarn dlx mocha test/foo.ts --require ts-node/register TS_NODE_FILES=true TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT="./test/tsconfig.json" pnpx mocha test/foo.ts --require ts-node/register
``` ```
### e2e tests
TODO
## Continuous integration
Misskey uses GitHub Actions for executing automated tests.
Configuration files are located in [`/.github/workflows`](/.github/workflows).
## Vue ## Vue
Misskey uses Vue(v3) as its front-end framework. Firefish uses Vue(v3) as its front-end framework.
- Use TypeScript. - Use TypeScript.
- **When creating a new component, please use the Composition API (with [setup sugar](https://v3.vuejs.org/api/sfc-script-setup.html) and [ref sugar](https://github.com/vuejs/rfcs/discussions/369)) instead of the Options API.** - **When creating a new component, please use the Composition API (with [setup syntax](https://v3.vuejs.org/api/sfc-script-setup.html) and [ref syntax](https://github.com/vuejs/rfcs/discussions/369)) instead of the Options API.**
- Some of the existing components are implemented in the Options API, but it is an old implementation. Refactors that migrate those components to the Composition API are also welcome. - Some of the existing components are implemented in the Options API, but it is an old implementation. Refactors that migrate those components to the Composition API are also welcome.
## nirax ## nirax

View File

@ -98,11 +98,11 @@ url: "https://{{ .Values.firefish.domain }}/"
#───┘ Port and TLS settings └─────────────────────────────────── #───┘ Port and TLS settings └───────────────────────────────────
# #
# Misskey requires a reverse proxy to support HTTPS connections. # Firefish requires a reverse proxy to support HTTPS connections.
# #
# +----- https://example.tld/ ------------+ # +----- https://example.tld/ ------------+
# +------+ |+-------------+ +----------------+| # +------+ |+-------------+ +----------------+|
# | User | ---> || Proxy (443) | ---> | Misskey (3000) || # | User | ---> || Proxy (443) | ---> | Firefish (3000) ||
# +------+ |+-------------+ +----------------+| # +------+ |+-------------+ +----------------+|
# +---------------------------------------+ # +---------------------------------------+
# #
@ -110,7 +110,7 @@ url: "https://{{ .Values.firefish.domain }}/"
# An encrypted connection with HTTPS is highly recommended # An encrypted connection with HTTPS is highly recommended
# because tokens may be transferred in GET requests. # because tokens may be transferred in GET requests.
# The port that your Misskey server should listen on. # The port that your Firefish server should listen on.
port: 3000 port: 3000
# ┌──────────────────────────┐ # ┌──────────────────────────┐

View File

@ -139,10 +139,10 @@ describe("After user singed in", () => {
it("note", () => { it("note", () => {
cy.get("[data-cy-open-post-form]").click(); cy.get("[data-cy-open-post-form]").click();
cy.get("[data-cy-post-form-text]").type("Hello, Misskey!"); cy.get("[data-cy-post-form-text]").type("Hello, Firefish!");
cy.get("[data-cy-open-post-form-submit]").click(); cy.get("[data-cy-open-post-form-submit]").click();
cy.contains("Hello, Misskey!"); cy.contains("Hello, Firefish!");
}); });
}); });

View File

@ -1,5 +1,5 @@
/** /**
* Misskey Entry Point! * Firefish Entry Point
*/ */
import { EventEmitter } from "node:events"; import { EventEmitter } from "node:events";

View File

@ -70,7 +70,7 @@ export function parseUri(value: string | IObject): UriParseResult {
export default class DbResolver { export default class DbResolver {
/** /**
* AP Note => Misskey Note in DB * AP Note => Firefish Note in DB
*/ */
public async getNoteFromApId(value: string | IObject): Promise<Note | null> { public async getNoteFromApId(value: string | IObject): Promise<Note | null> {
const parsed = parseUri(value); const parsed = parseUri(value);
@ -114,7 +114,7 @@ export default class DbResolver {
} }
/** /**
* AP Person => Misskey User in DB * AP Person => Firefish User in DB
*/ */
public async getUserFromApId( public async getUserFromApId(
value: string | IObject, value: string | IObject,
@ -147,7 +147,7 @@ export default class DbResolver {
} }
/** /**
* AP KeyId => Misskey User and Key * AP KeyId => Firefish User and Key
*/ */
public async getAuthUserFromKeyId(keyId: string): Promise<{ public async getAuthUserFromKeyId(keyId: string): Promise<{
user: CacheableRemoteUser; user: CacheableRemoteUser;
@ -181,7 +181,7 @@ export default class DbResolver {
} }
/** /**
* AP Actor id => Misskey User and Key * AP Actor id => Firefish User and Key
*/ */
public async getAuthUserFromApId(uri: string): Promise<{ public async getAuthUserFromApId(uri: string): Promise<{
user: CacheableRemoteUser; user: CacheableRemoteUser;

View File

@ -279,7 +279,7 @@ async function addSecurityKey() {
challenge: byteify(challenge.challenge, "base64"), challenge: byteify(challenge.challenge, "base64"),
rp: { rp: {
id: hostname, id: hostname,
name: "Misskey", name: "Firefish",
}, },
user: { user: {
id: byteify($i!.id, "ascii"), id: byteify($i!.id, "ascii"),

View File

@ -47,7 +47,7 @@ type StreamEvents = {
} & BroadcastEvents; } & BroadcastEvents;
/** /**
* Misskey stream connection * Firefish stream connection
*/ */
export default class Stream extends EventEmitter<StreamEvents> { export default class Stream extends EventEmitter<StreamEvents> {
private stream: ReconnectingWebsocket; private stream: ReconnectingWebsocket;