|
@@ -2,7 +2,8 @@
|
2
|
2
|
|
3
|
3
|
This project is the frontend part of Tracim.
|
4
|
4
|
|
5
|
|
-### Installation
|
|
5
|
+### Installation
|
|
6
|
+
|
6
|
7
|
Install all dependencies
|
7
|
8
|
`$ npm install`
|
8
|
9
|
|
|
@@ -11,7 +12,8 @@ Build the sources
|
11
|
12
|
|
12
|
13
|
Load `dist/index.html` in your webserver.
|
13
|
14
|
|
14
|
|
-### Development
|
|
15
|
+### Development
|
|
16
|
+
|
15
|
17
|
Install all dependencies
|
16
|
18
|
`$ npm install`
|
17
|
19
|
|
|
@@ -25,13 +27,15 @@ Start mockapi server
|
25
|
27
|
|
26
|
28
|
|
27
|
29
|
### Apps
|
|
30
|
+
|
28
|
31
|
Tracim is a skeleton that rely on apps to do stuffs. (like to manage Documents, Files, Threads ...)
|
29
|
32
|
|
30
|
33
|
Apps all are independant React applications and have their own repositories and can be freely added or removed from Tracim without the needs for a rebuild.
|
31
|
34
|
|
32
|
35
|
Apps acts like plugins.
|
33
|
36
|
|
34
|
|
-#### To add Apps to your Tracim instance
|
|
37
|
+#### To add Apps to your Tracim instance
|
|
38
|
+
|
35
|
39
|
You need to separately get the built version of each apps and add them to `dist/app` folder. Apps file names should be of the form of '__appName__.app.js'.
|
36
|
40
|
|
37
|
41
|
To do that
|
|
@@ -44,6 +48,7 @@ To do that
|
44
|
48
|
By default, for development, tracim_front expects every apps but wont crash if one is missing (currenlt not all of them are exists anyway)
|
45
|
49
|
|
46
|
50
|
### Developing Apps
|
|
51
|
+
|
47
|
52
|
Apps are independents React application so you can test them out on their own.
|
48
|
53
|
|
49
|
54
|
/!\ Documentation on Apps interface is work in progress. /!\
|