Browse Source

update readme

philippe 5 years ago
parent
commit
587beaa178
1 changed files with 38 additions and 0 deletions
  1. 38 0
      README.md

+ 38 - 0
README.md View File

@@ -2,3 +2,41 @@ develop branch status:
2 2
 [![Build Status](https://travis-ci.org/tracim/tracim_v2.svg?branch=develop)](https://travis-ci.org/tracim/tracim_v2)
3 3
 [![Coverage Status](https://coveralls.io/repos/github/tracim/tracim_v2/badge.svg?branch=develop)](https://coveralls.io/github/tracim/tracim_v2?branch=develop)
4 4
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tracim/tracim_v2/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/tracim/tracim_v2/?branch=develop)
5
+
6
+## Install Tracim on your server ##
7
+
8
+Following the installation documentation below, you'll be able to run your own instance on your server.
9
+
10
+----
11
+
12
+# Installation #
13
+
14
+## Get the source ##
15
+
16
+Get the sources from GitHub:
17
+
18
+    git clone https://github.com/tracim/tracim_v2.git
19
+    cd tracim_v2/
20
+
21
+## Install backend ##
22
+
23
+    ./setup_default_backend.sh
24
+
25
+## Install frontend ##
26
+
27
+    ./install_frontend_dependencies.sh
28
+    ./build_full_frontend.sh
29
+
30
+## Running Tracim  ##
31
+
32
+    cd backend/
33
+    source env/bin/activate
34
+    pserve development.ini
35
+
36
+You can now enter the application at
37
+[http://127.0.0.1:6543](http://127.0.0.1:6543) and login with admin user:
38
+
39
+ * user : `admin@admin.admin`
40
+ * password : `admin@admin.admin`
41
+
42
+