Skip to content

Commit 2524b53

Browse files
committed
Add development manual
1 parent c4488de commit 2524b53

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Namespace for MAM based projects
2+
3+
## Development
4+
5+
### Local
6+
7+
1. Update NodeJS to LTS
8+
2. Clone [MAM repository](https://github.com/hyoo-ru/mam) and install dependencies via npm or yarn
9+
10+
```bash
11+
git clone https://github.com/hyoo-ru/mam.git ./mam
12+
cd ./mam
13+
npm install
14+
```
15+
16+
3. Clone [this repository](https://github.com/aspirity-ru/mam_aspirity) to `./mam/aspirity`
17+
18+
```bash
19+
git clone https://github.com/aspirity-ru/mam_aspirity.git ./aspirity
20+
```
21+
22+
4. Build the project you want `npm run start aspirity/<project-name>`
23+
24+
5. Run dev server `npm run start`
25+
6. Open url `http://127.0.0.1:9080`
26+
7. Disable cache in devtools
27+
8. Select project in browser
28+
29+
### Gitpod
30+
31+
1. Open [![Gitpod Online Dev Workspace](https://img.shields.io/badge/Gitpod-Online--Dev--Workspace-blue?logo=gitpod)](https://gitpod.io/#https://github.com/hyoo-ru/mam)
32+
2. Install recommended plugins
33+
3. And continue from point 3 in the Local section
34+
35+
### Setup VSCode
36+
- Use MAM directory as root of your project in editor
37+
- [Install VScode intellisense plugin for *.view.tree files](https://marketplace.visualstudio.com/items?itemName=valikov.tree-language-service)
38+
- [Install plugin for *.tree files](https://open-vsx.org/extension/nin-jin/vscode-language-tree)
39+
- [Install .editorconfig plugin](https://open-vsx.org/extension/EditorConfig/EditorConfig)
40+
41+
### How to make VSCode support multiple GIT repositories
42+
43+
1. Create `./mam/.gitmodules` file with similar content.
44+
```
45+
[submodule "aspirity_restmock"]
46+
path = aspirity/restmock
47+
url = git@github.com:aspirity-ru/aspirity_restmock.git
48+
```
49+
2. Edit name, path and link as needed. The file can contain many submodules

0 commit comments

Comments
 (0)