mirror of
https://github.com/wekan/wekan.git
synced 2026-11-20 15:45:01 -05:00
CHANGELOG.md showed only the five newest releases, so what was about to be released was only in CHANGELOG-big.md. changelog-short.mjs now puts the unreleased # Upcoming WeKan ® release first - its In short and a link to its full section - and the five newest releases below it; right after a release, when there is no Upcoming yet, none is invented. CLAUDE.md and AGENTS.md say what "update wekan changelog" means: find the commits not in the changelog yet, add an Upcoming section when a release was cut meanwhile, write the entries and the In short into CHANGELOG-big.md, run changelog-short.mjs, run the changelog tests, and commit both files. tests/changelogShort.test.cjs: Upcoming first, whole, above the releases, its link resolves, and no Upcoming appears after a release. Thanks to xet7 !
316 lines
28 KiB
Markdown
316 lines
28 KiB
Markdown
# Where everything is
|
|
|
|
The sections below walk through the directories in detail. This table is the
|
|
whole tree at a glance, because the detail is easy to get lost in - and because
|
|
for years this page described four directories out of twenty and did not say so.
|
|
|
|
| Directory | What is in it |
|
|
| --- | --- |
|
|
| [client/](../../client) | everything the browser runs: Blaze components, their styles, the client-side libraries |
|
|
| [server/](../../server) | everything only the server runs: startup, publications, methods, the REST routes, `lib/` |
|
|
| [models/](../../models) | the collections, their schemas, helpers and mutations - shared by both, so a model must never import from `server/` |
|
|
| [imports/](../../imports) | shared code that is neither a model nor a component: i18n, the reactive cache, the shared SimpleSchema, startup |
|
|
| [packages/](../../packages) | the Meteor packages WeKan maintains itself - the accounts integrations (CAS, LDAP, OIDC, Sandstorm), the lockout, markdown |
|
|
| [config/](../../config) | the router and the accounts configuration |
|
|
| [migrations/](../../migrations) | one file per database migration, run in order at startup |
|
|
| [public/](../../public) | files served as-is: icons, fonts, the web app manifest |
|
|
| [private/](../../private) | files the SERVER can read and the client cannot |
|
|
| [tests/](../../tests) | the suites - `*.test.cjs` run by `tests/run-node-suites.cjs`, plus the Playwright and e2e directories |
|
|
| [docs/](..) | this documentation |
|
|
| [releases/](../../releases) | how a release is built and published - the bundle steps, the translations tooling, the CHANGELOG tooling |
|
|
| [snap/](../../snap), [snap-src/](../../snap-src), [snap-base-debian/](../../snap-base-debian) | the snap package |
|
|
| [sandstorm-src/](../../sandstorm-src) | the Sandstorm package |
|
|
| [openapi/](../../openapi) | the REST API description, generated from the routes |
|
|
| [meta/](../../meta) | signatures, icons, screenshots, project description |
|
|
| [old-CHANGELOG/](../../old-CHANGELOG) | the CHANGELOG's history, by year and by month, a busy month in parts (`CHANGELOG-big.md` holds the Status, the upcoming release and the newest releases that fit GitHub's 500 KiB Markdown limit; `CHANGELOG.md` only the In short of the upcoming release and the five newest) |
|
|
| `.tools/` | NOT part of this repository: the companion repos and toolchains a build needs, ignored by git and by Meteor |
|
|
| `node_modules/`, `.meteor/`, `.build/`, `_build/` | generated; never edited, never committed |
|
|
|
|
The two build directories are different things, and the names are close enough
|
|
to be worth stating:
|
|
|
|
| | what it is |
|
|
| --- | --- |
|
|
| `.build/` | the RELEASE bundle, from `meteor build .build --directory`. `.build/bundle` is what gets deployed, tested and packaged. |
|
|
| `_build/` | rspack's compiled output, written by ANY Meteor compile — a dev run, a test run, a release build. Meteor reads the app's main modules from `_build/main-prod/`, so it is a HANDOFF, not a leftover. |
|
|
|
|
`_build/` is gitignored but must **not** be added to `.meteorignore` — ignoring
|
|
it breaks the build outright, and that file explains why. Anything that walks
|
|
the repository should skip it: it holds a second, bundled copy of every source
|
|
file, so a tool that reads it finds every file twice and reports the bundler's
|
|
rewritten code as if it were source.
|
|
|
|
Two rules that the layout only implies:
|
|
|
|
- **`models/` is shared code.** It is loaded on the client too, so a model that
|
|
imports from `server/` breaks the client build. Server-only logic that a model
|
|
needs lives behind `Meteor.isServer` or in `server/lib/`.
|
|
- **A `.jade` file is not picked up by being on disk.** Every template is
|
|
imported by name from `client/features/*.js`, and a component `.js` that other
|
|
components import must import its own `.jade` - see
|
|
`tests/clientBundleImports.test.cjs` and `tests/templateRegistration.test.cjs`.
|
|
|
|
# Routing
|
|
|
|
We're using [FlowRouter](https://github.com/kadirahq/flow-router) client side router inside **[config/router.js](../../config/router.js)**.
|
|
For accounts there is [AccountsTemplates](https://github.com/meteor-useraccounts) configured in **[config/accounts.js](../../config/accounts.js)**.
|
|
|
|
# Client
|
|
|
|
## public
|
|
|
|
Files in this directory are served by meteor as-is to the client. It hosts some (fav)icons and fonts.
|
|
**[svg-etc/manifest.json](../../public/svg-etc/manifest.json)**: goes into `link rel="manifest"` in the header of the generated page and is a [Web App Manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest).
|
|
|
|
## components
|
|
|
|
* **[activities](../../client/components/activities)**:
|
|
* **[activities.jade](../../client/components/activities/activities.jade)**: `activities` template for the list of activities placed inside a `sidebar-content`; uses `boardActivities` or `cardActivities` depending on `mode`; <span style="color:red">*XXX: does this mean that sidebar should be visible in board list mode? when does the `board` activity gets shown?*</span>
|
|
* **[comments.jade](../../client/components/activities/comments.jade)**: `commentForm` template used in `card-details-canvas` for adding comments;
|
|
* **[boards](../../client/components/boards)**:
|
|
* **[boardArchive.jade](../../client/components/boards/boardArchive.jade)**: `archivedBoards` template for the modal dialog showing the list of archived boards that might be restored;
|
|
* **[boardBody.jade](../../client/components/boards/boardBody.jade)**: top level template for presenting a board is `board` and, based on screen size and current state, it uses either `cardDetails` or `boardBody` templates; `boardBody` is the one including the `sidebar`, each `list`, `cardDetails` for larger screens when a card is selected and the `addListForm` for adding a new list (also defined in this file);
|
|
* **[boardHeader.jade](../../client/components/boards/boardHeader.jade)**: `boardHeaderBar`, `boardMenuPopup`, `boardVisibilityList`, `boardChangeVisibilityPopup`, `boardChangeWatchPopup`, `boardChangeColorPopup`, `createBoard`, `chooseBoardSource`, `boardChangeTitlePopup`, `archiveBoardPopup`, `outgoingWebhooksPopup`;
|
|
* **[boardsList.jade](../../client/components/boards/boardsList.jade)**: `boardList` and `boardListHeaderBar` for the list of boards in the initial screen;
|
|
* **[cards](../../client/components/cards)**:
|
|
* **[attachments.jade](../../client/components/cards/attachments.jade)**: `cardAttachmentsPopup`, `previewClipboardImagePopup`, `previewAttachedImagePopup`, `attachmentDeletePopup`, `attachmentsGalery`;
|
|
* **[cardDate.jade](../../client/components/cards/cardDate.jade)**: `editCardDate` and `dateBadge` templates;
|
|
* **[cardDetails.jade](../../client/components/cards/cardDetails.jade)**: `boardsAndLists` is the usual layout for a board display with `boardLists` being used in sandstorm where each board is independent;`cardDetails`, `editCardTitleForm`, `cardDetailsActionsPopup`, `moveCardPopup`, `copyCardPopup`,`cardMembersPopup`,`cardMorePopup`, `cardDeletePopup`;
|
|
* **[cardTime.jade](../../client/components/cards/cardTime.jade)**: `editCardSpentTime` and `timeBadge` templates;
|
|
* **[checklists.jade](../../client/components/cards/checklists.jade)**: `checklists`, `checklistDetail`, `checklistDeleteDialog`, `addChecklistItemForm`, `editChecklistItemForm`, `checklistItems`, `itemDetail`;
|
|
* **[labels.jade](../../client/components/cards/labels.jade)**: `formLabel`, `createLabelPopup`, `editLabelPopup`, `deleteLabelPopup`, `cardLabelsPopup`;
|
|
* **[minicard.jade](../../client/components/cards/minicard.jade)**: has the `minicard` template
|
|
* **[forms](../../client/components/forms)**: **[inlinedform.jade](../../client/components/forms/inlinedform.jade)** has the`inlinedForm` template;
|
|
* **[import](../../client/components/import)**:
|
|
* **[import.jade](../../client/components/import/import.jade)**: `importHeaderBar`, `import`, `importTextarea`, `importMapMembers`, `importMapMembersAddPopup` are all templates used for importing Trello (via **[trelloMembersMapper.js](../../client/components/import/trelloMembersMapper.js)**) and Wekan (via **[wekanMembersMapper.js](../../client/components/import/wekanMembersMapper.js)**) boards;
|
|
* **[lists](../../client/components/lists)**:
|
|
* **[list.jade](../../client/components/lists/list.jade)**: `list` is the simple, main template for lists;
|
|
* **[listBody.jade](../../client/components/lists/listBody.jade)**: `listBody`, `addCardForm`, `autocompleteLabelLine` templates;
|
|
* **[listHeader.jade](../../client/components/lists/listHeader.jade)**: `listHeader`, `editListTitleForm`, `listActionPopup`, `boardLists`, `listMorePopup`, `listDeletePopup`, `setWipLimitPopup`, `wipLimitErrorPopup` templates;
|
|
* **[main](../../client/components/main)**:
|
|
* **[editor.jade](../../client/components/main/editor.jade)**: `editor` and `viewer` templates;
|
|
* **[header.jade](../../client/components/main/header.jade)**: `header` and `offlineWarning` templates; if the user is connected we display a small "quick-access" top bar that list all starred boards with a link to go there (this is inspired by the Reddit "subreddit" bar); the first link goes to the boards page;
|
|
* **[keyboardShortcuts.jade](../../client/components/main/keyboardShortcuts.jade)**: `shortcutsHeaderBar`, `shortcutsModalTitle`, `keyboardShortcuts` - all for the shortcuts that are presented when you press `?`re implemented inhere;
|
|
* **[layouts.jade](../../client/components/main/layouts.jade)**: has the template for head portion of the html page and other general purpose templates: `userFormsLayout`, `defaultLayout`, `notFound`, `message`;
|
|
* **[popup.tpl.jade](../../client/components/main/popup.tpl.jade)**: tpl files only define a single template so there's no need to wrap content in a template tag; the name of the template is the base name of the file (`popup` in this case);
|
|
* **[settings](../../client/components/settings)**:
|
|
* **[informationBody.jade](../../client/components/settings/informationBody.jade)**: the `statistics` template — the Version pane of Admin Panel / Settings, five tables (Platform, OS, Meteor, Database, Node). There is no `information` template any more: it is a pane rendered by `settingBody.jade`, not a page;
|
|
* **[invitationCode.jade](../../client/components/settings/invitationCode.jade)**: `invitationCode` template;
|
|
* **[peopleBody.jade](../../client/components/settings/peopleBody.jade)**: `people`, `peopleGeneral`, `peopleRow`, `editUserPopup`;
|
|
* **[settingBody.jade](../../client/components/settings/settingBody.jade)**: `setting`, `general`, `email`, `accountSettings`, `announcementSettings`
|
|
* **[settingHeader.jade](../../client/components/settings/settingHeader.jade)**: `settingHeaderBar` template;
|
|
* **[sidebar](../../client/components/sidebar)**:
|
|
* **[sidebar.jade](../../client/components/sidebar/sidebar.jade)**: `sidebar`, `homeSidebar`, `membersWidget`, `labelsWidget`, `memberPopup`, `removeMemberPopup`, `leaveBoardPopup`, `addMemberPopup`, `changePermissionsPopup`
|
|
* **[sidebarArchives.jade](../../client/components/sidebar/sidebarArchives.jade)**: `archivesSidebar`
|
|
* **[sidebarFilters.jade](../../client/components/sidebar/sidebarFilters.jade)**: `filterSidebar`, `multiselectionSidebar`, `disambiguateMultiLabelPopup`, `disambiguateMultiMemberPopup`, `moveSelectionPopup`;
|
|
* **[users](../../client/components/users)**:
|
|
* **[userAvatar.jade](../../client/components/users/userAvatar.jade)**: `userAvatar`, `userAvatarInitials`, `userPopup`, `memberName`, `changeAvatarPopup`, `cardMemberPopup`
|
|
* **[userHeader.jade](../../client/components/users/userHeader.jade)**: `headerUserBar`, `memberMenuPopup`, `editProfilePopup`, `editNotificationPopup`, `changePasswordPopup`, `changeLanguagePopup`, `changeSettingsPopup`;
|
|
|
|
## features
|
|
|
|
**[client/features](../../client/features)** is the list of what the client
|
|
LOADS. One file per area - `boards.js`, `cards.js`, `settings.js`, `main.js` and
|
|
so on - each importing that area's `.jade`, then its `.js`, then its `.css`, and
|
|
`client/imports.js` imports them all. A component that is not named here is not
|
|
in the bundle, however finished it is: `tests/templateRegistration.test.cjs`
|
|
fails when a template is included by name and never imported.
|
|
|
|
## config
|
|
|
|
* **[blazeHelpers.js](../../client/config/blazeHelpers.js)**: following [Blaze](http://blazejs.org/) helpers are registered here:`currentBoard()`, `currentCard()`, `getUser()` and `concat()`;
|
|
* **[gecko-fix.js](../../client/config/gecko-fix.js)**: removes [deprecated](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/watch)`watch` and `unwatch` from Firefox prior to version 58;
|
|
|
|
## lib
|
|
|
|
* **[accessibility.js](../../client/lib/accessibility.js)**: define a set of DOM transformations that are specifically intended for blind screen readers;
|
|
* **[cssEvents.js](../../client/lib/cssEvents.js)**: the `CSSEvents`object has methods that select the name of the event based on the specific transitions and animations;
|
|
* **[pasteImage.js](../../client/lib/pasteImage.js)** and **[dropImage.js](../../client/lib/dropImage.js)**: utility for pasting and dropping images on a web app; <span style="color:red">*XXX: add comments; not same style as the rest of the code*</span>
|
|
* **[escapeActions.js](../../client/lib/escapeActions.js)**: defines the behavior (mostly canceling current edit) for escape keyboard key;
|
|
* **[i18n.js](../../client/lib/i18n.js)**: at startup we choose the language for the ui based on user profile or browser language;
|
|
* **[inlinedform.js](../../client/lib/inlinedform.js)**: forms for editing a single field (like adding a card); <span style="color:red">*XXX: comments in code suggest that a form that is not submitted will retain its value to prevent data loss using [unsavedEdits.js](../../client/lib/unsavedEdits.js);bug?*</span>; <span style="color:red">*XXX: edit button to save and open*</span>;
|
|
* **[minicardLabelText.js](../../client/lib/minicardLabelText.js)**: reads and writes the personal `Hide minicard label text` setting (the user's profile, or this browser when nobody is logged in), used by the minicard and by `Board Settings / Card`'s "Labels text" row;
|
|
* **[sectionCaret.js](../../client/lib/sectionCaret.js)**: which way a collapsible section's caret points — down when open, and toward the text when closed, mirrored in right-to-left languages — shared by the card's sections and the board sidebar's `Activities`;
|
|
* **[keyboard.js](../../client/lib/keyboard.js)**: the shortcuts that are presented when you press `?`re implemented inhere;
|
|
* **[popup.js](../../client/lib/popup.js)**: defines `Popup` class for things likes electing a date; <span style="color:red">*XXX: not a Blaze helper?*</span>
|
|
* **[textComplete.js](../../client/lib/textComplete.js)**: extends [jquery-textcomplete](https://yuku-t.com/jquery-textcomplete/) to integrate with the rest of the system (like escape actions, tab and enter key handling); <span style="color:red">*XXX: deprecated?*</span>
|
|
* **[utils.js](../../client/lib/utils.js)**: various methods all over the place (resize, screen size, sort, capitalize, navigate to board and card);
|
|
* **Blaze helpers**:
|
|
* **[filter.js](../../client/lib/filter.js)**: registers `Filter` [Blaze](http://blazejs.org/) helper to support filtering cards by labels and by members;
|
|
* **[modal.js](../../client/lib/modal.js)**: registers `Modal` [Blaze](http://blazejs.org/) helper to support showing modal windows like the one for archived boards;
|
|
* **[multiSelection.js](../../client/lib/multiSelection.js)**: registers `Modal` [Blaze](http://blazejs.org/) helper to support multiple selection mode;
|
|
* **[unsavedEdits.js](../../client/lib/unsavedEdits.js)**: registers `getUnsavedValue` and `hasUnsavedValue` [Blaze](http://blazejs.org/) helpers to preserve content entered in fields but not saved;
|
|
|
|
# Server
|
|
|
|
.js files in this directory are not available to the client.
|
|
|
|
The four directories that hold most of it:
|
|
|
|
* **[server/lib](../../server/lib)** - the server-only libraries the rest of it
|
|
calls. The security log and the event-log fold that Admin Panel / Problems is
|
|
built on, the login throttle and timing defence, the database problem
|
|
classifier, the API usage counter, the recovery and migration helpers.
|
|
* **[server/methods](../../server/methods)** - Meteor methods that are not part
|
|
of a model: the backups, the repairs, the reports the Admin Panel calls.
|
|
* **[server/publications](../../server/publications)** - what the client may
|
|
subscribe to, and with which fields.
|
|
* **[server/routes](../../server/routes)** - the HTTP routes that are not the
|
|
REST API: the avatar server, the attachment routes, the custom head assets.
|
|
The REST API itself is registered by the models, in front of
|
|
**[server/apiMiddleware.js](../../server/apiMiddleware.js)** - body parsing,
|
|
the `WITH_API` gate, bearer-token authentication, and the usage counting
|
|
behind Admin Panel / Problems / API.
|
|
* **[server/startup](../../server/startup)** and the `00*.js` files at the top -
|
|
what runs before anything else, in name order: the startup checks, waiting for
|
|
the database, the retry-on-busy wrapper, the error handlers.
|
|
|
|
* **[statistics.js](../../server/statistics.js)** implements a Meteor server-only [method](https://guide.meteor.com/methods.html) for general-purpose information such as OS, memory, CPUs, PID of the process and so on.
|
|
* **[migrations.js](../../migrations)** is where code that update sold databases to new schema is located. Anytime the schema of one of the collection changes in a non-backward compatible way a migration needs to be written in this file.
|
|
* **[authentication.js](../../server/authentication.js)** add the `Authentication`object to Meteor that provides methods for checking access rights.
|
|
* **[lib/utils.js](../../server/lib/utils.js)** defines some checks used by [checklists.js](../../models/checklists.js)** model. <span style="color:red">*XXX: these methods are defined in server-only code by are used in models, which are visible by the client (in Checklists.allow)?*</span>
|
|
* **[notifications](../../server/notifications)**
|
|
* **[notifications.js](../../server/notifications/notifications.js)**: defines the `Notifications` object that supports [Activities](../../models/activities.js) and holds a list of functions to call when its `notify()` method is called along with convenience methods to subscribe, unsubscribe and a way to filter recipients according to user settings for notification;
|
|
* **[email.js](../../server/notifications/email.js)**: makes use of the notification system to send an email to a user;
|
|
* **[profile.js](../../server/notifications/profile.js)**: *stub*; will allow associating notifications with user ids to be consumed by mobile apps;
|
|
* **[notifications.js](../../server/notifications/notifications.js)**: adds the `watch()` Meteor server-only [method](https://guide.meteor.com/methods.html) that may watch boards, lists or cards using [models/watchable.js](../../models/watchable.js);
|
|
* **[outgoing.js](../../server/notifications/outgoing.js)**: adds the `outgoingWebhooks()` Meteor server-only [method](https://guide.meteor.com/methods.html) that can call external API <span style="color:red">*XXX: I guess*</span>
|
|
* **[publications](../../server/publications)** defines sets of records that are [published](https://docs.meteor.com/api/pubsub.html#Meteor-publish) by the server and how clients can subscribe to those:
|
|
* **[accountSettings.js](../../server/publications/accountSettings.js)**: [AccountSettings](../../models/accountSettings.js) collection;
|
|
* **[activities.js](../../server/publications/activities.js)**: [Activities](../../models/activities.js) collection filtered and paginated;
|
|
* **[announcements.js](../../server/publications/announcements.js)**: [Announcements](../../models/announcements.js) collection;
|
|
* **[avatars.js](../../server/publications/avatars.js)**: [Avatars](../../models/avatars.js) collection for current user;
|
|
* **[boards.js](../../server/publications/boards.js)**: [Boards](../../models/boards.js) collection for current user, archived boards collection and individual board as a [relation](https://atmospherejs.com/cottz/publish-relations);
|
|
* **[cards.js](../../server/publications/cards.js)**: a [Card](../../models/cards.js) by its id;
|
|
* **[people.js](../../server/publications/people.js)**: [Users](../../models/users.js) collection;
|
|
* **[settings.js](../../server/publications/settings.js)**: [Settings](../../models/settings.js) collection and, separately, the mail server;
|
|
* **[unsavedEdits.js](../../server/publications/unsavedEdits.js)**: [UnsavedEdits](../../models/unsavedEdits.js) collection;
|
|
* **[users.js](../../server/publications/users.js)**: provides a "mini-profile" for individual users and a [way](https://docs.meteor.com/api/collections.html#fieldspecifiers) to check if current user is admin.
|
|
|
|
# Models
|
|
|
|
The files in **[models](../../models)** directory mainly define collections; most of them have [aldeed SimpleSchema](https://atmospherejs.com/aldeed/simple-schema) for automatic validation of insert and update of collections. This is also where helpers, mutations, methods, hooks and bootstrap code is to be found. [Server side code](https://docs.meteor.com/api/core.html#Meteor-isServer) also implements json REST API.
|
|
|
|
**[models/lib](../../models/lib)** is the other half of this directory, and by
|
|
file count the larger one: the PURE modules a model, the server and the client
|
|
all share - the event-log summary shape, the address classifier, the admin URLs
|
|
and menus, the shared table page, the lockout state, the map links. They are
|
|
plain CommonJS with no Meteor in them, which is what lets
|
|
`tests/*.test.cjs` run them under bare node and test a decision as arithmetic
|
|
rather than through a server.
|
|
|
|
Collections (mostly `Mongo.Collection` except as noted) are defined in:
|
|
* **[accountSettings.js](../../models/accountSettings.js)**;
|
|
* **[activities.js](../../models/activities.js)**: does not have a SimpleSchema;
|
|
* **[announcements.js](../../models/announcements.js)**;
|
|
* **[attachments.js](../../models/attachments.js)**: file-system collection;
|
|
* **[avatars.js](../../models/avatars.js)**: file-system collection;
|
|
* **[boards.js](../../models/boards.js)**;
|
|
* **[cardComments.js](../../models/cardComments.js)**;
|
|
* **[cards.js](../../models/cards.js)**;
|
|
* **[checklists.js](../../models/checklists.js)**;
|
|
* **[integrations.js](../../models/integrations.js)**;
|
|
* **[invitationCodes.js](../../models/invitationCodes.js)**;
|
|
* **[lists.js](../../models/lists.js)**;
|
|
* **[settings.js](../../models/settings.js)**;
|
|
* **[unsavedEdits.js](../../models/unsavedEdits.js)**;
|
|
* **[users.js](../../models/users.js)**: extends the `Meteor.users` collection.
|
|
|
|
Other files:
|
|
* **[watchable.js](../../models/watchable.js)**: extends the schema, helpers and mutations of `Boards`, `Lists` and `Cards`.
|
|
* **[export.js](../../models/export.js)**: has some code to support the REST API.
|
|
* **[import.js](../../models/import.js)**: implements `importBoard()` method so that Trello (in **[trelloCreator.js](../../models/trelloCreator.js)**) and Wekan (in **[wekanCreator.js](../../models/wekanCreator.js)**) boards can be imported. <span style="color:red">*XXX: Solid candidates for a directory of their own.*</span>
|
|
|
|
# Tools
|
|
|
|
* Git:
|
|
* **.git**;
|
|
* **[.gitignore](../../.gitignore)**;
|
|
* Docker:
|
|
* **[docker-compose.yml](../../docker-compose.yml)**: the compose file is a YAML file defining services, networks and volumes;
|
|
* **[Dockerfile](../../Dockerfile)**;
|
|
* Snap:
|
|
* **[snapcraft.yaml](../../snapcraft.yaml)**: [Snapcraft](https://snapcraft.io/) packages any app for every Linux desktop, server, cloud or device, and deliver updates directly;
|
|
* **[snap](../../snap)**;
|
|
* **[snap-src](../../snap-src)**;
|
|
* Sandstorm:
|
|
* **[sandstorm.js](../../sandstorm.js)**: [Sandstorm](https://sandstorm.org/) specific code;
|
|
* **[sandstorm-pkgdef.capnp](../../sandstorm-pkgdef.capnp)**: used the meteor-spk tool to generate a sandstorm package;
|
|
* Node:
|
|
* **[package.json](../../package.json)**;
|
|
* **node_modules**
|
|
* **[app.json](../../app.json)**: is a manifest format for describing web apps (build requirements, environment variables, addons, and other information);
|
|
* **[app.env](../../app.env)**: environment variables;
|
|
* Meteor: is a full-stack JavaScript platform for developing modern web and mobile applications.
|
|
* **[.meteor](../../.meteor)**;
|
|
* Translation:
|
|
* **[i18n](../../imports/i18n/data)** directory has one .json file for each supported language
|
|
* **[.tx](../../.tx)**: configuration for [Transifex](https://app.transifex.com/wekan/) tool used to manage translation;
|
|
* Text editors:
|
|
* **[.vscode](../../.vscode)**: [Visual Studio Code Editor](https://code.visualstudio.com/docs/getstarted/settings);
|
|
* **[.editorconfig](../../.editorconfig)**: [EditorConfig](http://EditorConfig.org) provides consistent coding styles between different editors and IDEs;
|
|
* **[.github](../../.github)**: hosts the issues template;
|
|
* **[.eslintrc.json](../../.eslintrc.json)**: [ESLint](https://eslint.org/docs/user-guide/configuring) configuration;
|
|
* **[.travis.yml](../../.travis.yml)**: configuration for [Travis CI](https://travis-ci.org/);
|
|
* **[scalingo.json](../../scalingo.json)**: [Scalingo](https://scalingo.com/) is a deploy solution;
|
|
|
|
# Building, releasing and testing
|
|
|
|
* **[build.sh](../../build.sh)** / **[build.bat](../../build.bat)** - the menu
|
|
that installs dependencies, builds WeKan and runs the tests. Its Setup menu
|
|
builds either the **release bundle** (what a release publishes, minus the
|
|
.zip) or the **development bundle** (plain `meteor build`).
|
|
* **[releases/](../../releases)** - one script per step of a release, and the
|
|
same scripts the GitHub workflow runs, so a release can be reproduced locally:
|
|
* **[release-all.sh](../../releases/release-all.sh)** - the whole release, from
|
|
the CHANGELOG's `# Upcoming` section; takes no version number.
|
|
* **[build-release-bundle.sh](../../releases/build-release-bundle.sh)** - the
|
|
bundle a release publishes, for the machine it is run on.
|
|
* **[bundle-trim.mjs](../../releases/bundle-trim.mjs)**,
|
|
**[prune-unreachable-npm.mjs](../../releases/prune-unreachable-npm.mjs)**,
|
|
**[bundle-smoke-boot.sh](../../releases/bundle-smoke-boot.sh)** - what a
|
|
bundle carries, what it does not, and whether it starts at all.
|
|
* **[translations/](../../releases/translations)** - the Transifex pull and the
|
|
per-key merge that never overwrites a human translation.
|
|
* **[changelog-archive.mjs](../../releases/changelog-archive.mjs)** - moves
|
|
finished months out of `CHANGELOG-big.md` into `old-CHANGELOG/`.
|
|
* **[changelog-short.mjs](../../releases/changelog-short.mjs)** - writes
|
|
`CHANGELOG.md`, the In short of the upcoming release and the five newest,
|
|
from `CHANGELOG-big.md`.
|
|
* **[tests/](../../tests)** - `*.test.cjs` suites run by
|
|
**[run-node-suites.cjs](../../tests/run-node-suites.cjs)** (all of them, with
|
|
every failure listed at the end), plus the Playwright browser tests and the
|
|
e2e/import suites. Many of them READ THE SOURCE and pin a behaviour, which is
|
|
what makes "and this mistake is nowhere else in the tree" checkable.
|
|
* **[.github/workflows](../../.github/workflows)** - `release-all.yml` is the
|
|
release: the bundles for every platform, the Docker images, the snaps, and the
|
|
GitHub Release they attach to.
|
|
|
|
# Info
|
|
|
|
* **[meta](../../meta)**: binary signatures, project description, icons, screenshots and, oui, a French change-log;
|
|
* **[CHANGELOG.md](../../CHANGELOG.md)** - the upcoming release and the five newest, in short, and
|
|
**[CHANGELOG-big.md](../../CHANGELOG-big.md)** - every change, the upcoming release and the status;
|
|
* **[Contributing.md](../../CONTRIBUTING.md)**;
|
|
* **[LICENSE](../../LICENSE)**;
|
|
* **[README.md](../../README.md)**.
|
|
|
|
---
|
|
|
|
# Contributions to this page
|
|
|
|
This page was contributed by [TNick](https://github.com/TNick) and
|
|
[xet7](https://github.com/xet7) when WeKan was at commit
|
|
[e2f768c](https://github.com/wekan/wekan/tree/e2f768c6a0f913b7c5f07695dce8cec692037255),
|
|
and it described the tree as it was then for a long time afterwards: fourteen of
|
|
its links pointed at files that had moved or been deleted, and two thirds of the
|
|
repository - `imports/`, `packages/`, `releases/`, `tests/`, `docs/`,
|
|
`migrations/`, `server/lib`, `server/methods`, `server/routes`, `models/lib`,
|
|
`client/features` - was not mentioned at all.
|
|
|
|
Please add new files, fixes and updates directly to this page.
|
|
`tests/docsLinksResolve.test.cjs` fails when a link here points at something that
|
|
is not in the tree, which is what let the fourteen rot unnoticed: a
|
|
`https://github.com/wekan/wekan/tree/main/...` link looks fine in an editor and
|
|
404s only for the reader.
|