develop branch status:

Tracim is a collaborative plateforme software intended for (not only technical) team collaboration. It is simple to use, offers a user-friendly interface and runs on every computer. It is very valuable for R&D teams, assocations, remote collaboration.

More information on the website: https://www.tracim.fr (in French)

Test tracim on your computer with docker:

mkdir -p ~/tracim/etc
mkdir -p ~/tracim/var
docker run -e DATABASE_TYPE=sqlite -e START_CALDAV=1 -p 8080:80 -v ~/tracim/etc:/etc/tracim -v ~/tracim/var:/var/tracim algoo/tracim

Then visit the url http://localhost:8080 and login in to tracim:

• email: admin@admin.admin
• password: admin@admin.admin

For advanced docker-based usage, look at the full tracim docker documentation,

Tracim is distributed under the terms of the MIT License.

In order to contribute to tracim source_code, please read CONTRIBUTING.md file

Get the sources from GitHub (you need git):

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

see Backend README

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_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.

Tracim is made of multiples services, some are web wsgi application and some others are daemons (server not web related to do some task like sending email).

An easy way to run tracim wsgi app with pastedeploy(config in development.ini):

cd backend/
source env/bin/activate

# running web server
pserve development.ini

You can run some other wsgi service with pastedeploy using tracimcli command:

# running webdav server
tracimcli webdav start

# running caldav server
tracimcli caldav start
tracimcli caldav sync  # sync tracim data with radicale caldav server

You can run some tracim daemon too if you want those feature:

# set tracim_conf_file path
export TRACIM_CONF_PATH="$(pwd)/development.ini"

## DAEMONS SERVICES
# email notifier (if async email notification is enabled)
python3 daemons/mail_notifier.py &

# email fetcher (if email reply is enabled)
python3 daemons/mail_fetcher.py &

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

• user: admin@admin.admin
• password: admin@admin.admin

Full documentation about it and about running tracim services with uwsgi/supervisor is available in Backend Readme file doc section Running Tracim Backend Daemon and Running Tracim Backend WSGI APP .

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 ).

⚠ To launch cypress test, you need a running tracim with specific config

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

You must change the apiUrl property in frontend/configEnv.json to

http://localhost:1337/api/v2

Then rebuild the frontend

cd frontend/
npm run build

This command run all test present in 'functionnal_tests/cypress/integration' folder.

cd functionnal_tests/
npm run cypress-run

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

cd functionnal_tests/
npm run cypress-open