tracim / tracim_v2

develop branch status:

Install Tracim on your server

Following the installation documentation below, you'll be able to run your own instance on your server.

---

Installation

Get the source

Get the sources from GitHub (you need git):

git clone https://github.com/tracim/tracim_v2.git
cd tracim_v2/

Install backend

Option 1: Install backend manually

see Backend README

Option2: Install backend: Automated script for easy setup

This script run backend with simple default conf: development.ini conf file, use default config file, sqlite database, etc...

./setup_default_backend.sh

This script use command with sudo, make sure you have installed and configured sudo. You can run also with root if you add root in parameter of this script.

For each conf file missing, this script will generated them from default conf. If sqlite default database is missing, script will generate it. This script is also able to serve for update. If you want to update a script generated tracim install, you can just update source code with git pull and rerun the same script to update database model, system deps and python deps.

for more information about configuring tracim_backend, see Backend README for more information about configuration file, see development.ini.sample documentation and Backend setting file doc.

Install frontend: Automated Script for easy setup

./install_frontend_dependencies.sh
./build_full_frontend.sh

This script use command with sudo, make sure you have installed and configured sudo. You can run also with root if you add root in parameter of this script.

You can add "-d" to build_full_frontend.sh to disabled obfuscation and reduce build time.

Running Tracim using pserve

cd backend/
source env/bin/activate
pserve development.ini

You can now enter the application at http://127.0.0.1:6543 and login with admin user:

• user: [e-mail]
• password: [e-mail]

---

Running tests with cypress

---

Installation of cypress: Automated script for easy setup

This script check if nodejs is installed (npm is necessary to install Cypress), if file package.json and cypress.json exist in 'functionnal_tests' folder. if not the script install necessary file and install Cypress and his dependency's.

./setup_functionnal_tests.sh

This script use command with sudo, make sure you have installed and configured sudo. You can run also with root if you add root in parameter of this script.

If you need to run cypress with external server of tracim, modify "baseurl" in cypress.json (look here for more detail: https://docs.cypress.io/guides/references/configuration.html#Options ).

Run tests with command line

This command run all test present in 'cypress_test' folder.

cd functionnal_tests/
./node_modules/.bin/cypress run

Run tests with cypressgui

Open Cypress with graphical interface. You can show test running directly in web interface.

cd functionnal_tests/
./node_modules/.bin/cypress open