midgard/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Merge pull request #1220 from Flaburgan/improve-readme

Browse source 
Improve README
This commit is contained in:
Pieter Vander Vennet 2023-01-05 01:07:17 +01:00 • committed by GitHub
commit c54f2e2d4a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Docs/Development_deployment.md
View file

@ -24,23 +24,23 @@ the switch ;) ). If you are using Visual Studio Code you can use
a [WSL Remote](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) window, or use the a [WSL Remote](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) window, or use the
Devcontainer (see more details later). Devcontainer (see more details later).
You need at least 3Gb available to run MapComplete.
To develop and build MapComplete, you To develop and build MapComplete, you
0. Make a fork and clone the repository. (We recommend a shallow clone with `git clone --filter=blob:none <repo>`) 0. Make a fork and clone the repository. (We recommend a shallow clone with `git clone --filter=blob:none <repo>`)
0. Install `python3` if you do not have it already 1. Install `python3` if you do not have it already
- On linux: `sudo apt install python3` - On linux: `sudo apt install python3`
- On windows: find the latest download on the [Python Releases for Windows page](https://www.python.org/downloads/windows/) - On windows: find the latest download on the [Python Releases for Windows page](https://www.python.org/downloads/windows/)
0. Install the nodejs version specified in [/.tool-versions](/.tool-versions) 2. Install the nodejs version specified in [/.tool-versions](/.tool-versions)
- On linux: install npm first `sudo apt install npm`, then install `n` using npm: ` npm install -g n`, which can - On linux: install npm first `sudo apt install npm`, then install `n` using npm: ` npm install -g n`, which can
then install node with `n install <node-version>` then install node with `n install <node-version>`. You can [use asdf to manage your runtime versions](https://asdf-vm.com/).
- You can [use asdf to manage your runtime versions](https://asdf-vm.com/). - Windows: install nodeJS: https://nodejs.org/en/download/
0. Install `npm`. Linux: `sudo apt install npm` (or your favourite package manager), Windows: install 3. Run `npm run init` which …
nodeJS: https://nodejs.org/en/download/
0. Run `npm run init` which …
- runs `npm install` - runs `npm install`
- generates some additional dependencies and files - generates some additional dependencies and files
0. Run `npm run start` to host a local testversion at http://localhost:1234/index.html 4. Run `npm run start` to host a local testversion at http://localhost:1234/index.html
0. By default, a landing page with available themes is served. In order to load a single theme, use `layout=themename` 5. By default, a landing page with available themes is served. In order to load a single theme, use `layout=themename`
or `userlayout=true#<layout configuration>` as [Query parameter](URL_Parameters.md). Note that the shorter URLs ( or `userlayout=true#<layout configuration>` as [Query parameter](URL_Parameters.md). Note that the shorter URLs (
e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version. e.g. `bookcases.html`, `aed.html`, ...) _don't_ exist on the development version.