A feature's guide now sits under the menu it is used from, read from the templates rather than from where somebody once put it: Header-Bar, All-Boards, Pages, Board-Header (search and every Board View), Board-Sidebar (Board Settings, Filter, Members, Labels, Archive), Rules, Swimlanes, Lists, Cards, Member-Settings, Admin-Panel and Login-Page. Topics used from several menus (editor, history, theme, translations, email, troubleshooting) are in General. - Each area has a README mapping its menu entries to their guides and to the template or server module that implements them. Board-Header/README.md lists all 40 Board View entries with the template boardBody.jade renders; five views (Table, Calendar Mode, Time, Timeline, Map) have no guide of their own yet and say so. - Board-View.md listed 25 views while BOARD_VIEWS has 40; it now lists all of them with their English labels. - Pages keep their file names. Where a released changelog links an old path, a "# Moved" page stays there and points to the new one; test-menu.sh skips folders holding only those. - Undo was filed under Login; it is General/Undo now. - Every link in docs, code comments, scripts and tests follows the move; docsLinksResolve checks them all. Tests that read a doc follow it to its new place. boardViewSettings now fails when Board-View.md or Board-Header/README.md differs from BOARD_VIEWS, or names a template boardBody.jade does not render. Thanks to xet7 !
3.3 KiB
Build WeKan and Create Pull Request
WeKan currently uses Meteor 3.
Before you commit: what not to add
A build writes two directories, both generated and both gitignored. Neither ever belongs in a pull request:
.build/— the release bundle, frommeteor build .build --directory..build/bundleis what gets deployed, tested and packaged._build/— rspack's compiled output, written by any Meteor compile. Meteor reads the app's main modules from_build/main-prod/, so it is a handoff rather than a leftover. It is gitignored, but must not be added to.meteorignore: ignoring it breaks the build.
git status should never list either. If it does, the checkout's ignore files
are out of date rather than the directories being something new — see
Directory-Structure.md.
Using newest Ubuntu amd64:
Meteor 3
1. Install git and configure it
sudo apt -y install git
git config --global user.name "YOUR-FIRSTNAME YOUR-LASTNAME"
git config --global user.email YOUR-EMAIL-ADDRESS@gmail.com
git config --global push.default simple
nano .ssh/config
There add your User (GitHub username) and IdentityFile (Your ssh private key. Not public key that has .pub). For indentation, use one tab.
Host *
IdentitiesOnly=yes
Host github.com
Hostname github.com
User YOUR-GITHUB-USERNAME
IdentityFile ~/.ssh/id_github
Save and Exit with Ctrl-o Enter Ctrl-x Enter
If you do not have ssh key, create it:
ssh-keygen -t ed25519 -f ~/.ssh/id_github
And press Enter about 3 times, until you have private key at ~/.ssh/id_github and public key at ~/.ssh/id_github.pub
Add public key .pub to your GitHub SSH Keys at https://github.com/settings/keys
2. Click Create fork at https://github.com/wekan/wekan webpage
mkdir repos
cd repos
git clone git@github.com:YOUR-GITHUB-USERNAME/wekan.git
cd wekan
IMPORTANT: Do NOT npm audit fix --force
Because it downgrades @meteorjs/rspack and breaks builds.
3. Install dependencies, build WeKan, and run the dev server
build.sh shows a two-level menu. The top level is 1) Setup 2) Dev server 3) Tests 4) Docker 5) Tools 6) Quit; pick a category number, then the item number inside it (each submenu also has a Back entry).
# Setup -> Install dependencies
./build.sh
1 # Setup
1 # Install dependencies
# Setup -> Build WeKan
./build.sh
1 # Setup
2 # Build WeKan
# Dev server -> localhost:3000
./build.sh
2 # Dev server
1 # localhost:3000
That does:
- Setup -> Install dependencies installs dependencies,
- Setup -> Build WeKan builds wekan,
- Dev server -> localhost:3000 starts wekan in development mode with command
meteor, so it can detect if some file changes and try to rebuild automatically. If a dev server is already running on that port, it is stopped first and a fresh one started on the same port.
And then register and login with webbrowser at http://localhost:3000
4. Make and test your changes
Use build.sh to run all tests.
5. If it works, create pull request
When your changes work, commit them:
git add --all
git commit -m "Describe your change here."
git push
And then at your GitHub for https://github.com/YOUR-GITHUB-USERNAME/wekan click Create pull request.