PhilippeAccorsi 76212bff12
Merge pull request #24 from tracim/fix/better_readme
6 лет назад
backend Update setting.md 6 лет назад
frontend https://github.com/tracim/tracim/issues/799, fix the width of profil subdropdown btn 6 лет назад
frontend_app_admin_workspace_user [https://github.com/tracim/tracim/issues/787] added link to admin pages in top right user dropdown 6 лет назад
frontend_app_html-document [https://github.com/tracim/tracim/issues/641] apps htmldoc and thread now mark content as read upon loading data 6 лет назад
frontend_app_thread [https://github.com/tracim/tracim/issues/641] apps htmldoc and thread now mark content as read upon loading data 6 лет назад
frontend_app_workspace fixed respectives app's index.html with correct assset link + removed unused symlink 6 лет назад
frontend_lib [https://github.com/tracim/tracim/issues/792] added remember me feature 6 лет назад
functionnal_tests fix for cypress script 6 лет назад
.gitignore add folder in gitignore 6 лет назад
.travis.yml travis: separate install requires from testing requires 6 лет назад
README.md add cypress information 6 лет назад
README_traduction.md Update README_traduction.md 6 лет назад
backend_lib.sh update backend setup script 6 лет назад
bash_library.sh fix for script install cypress 6 лет назад
build_full_frontend.sh added folder creation in build_full_frontend.sh 6 лет назад
color.json.sample added color.json.sample 6 лет назад
i18next.option.js [https://github.com/tracim/tracim/issues/637] added translation mecanism on all frontend folder 6 лет назад
install_cypress.sh fix for cypress script 6 лет назад
install_frontend_dependencies.sh fix regex error 6 лет назад
setup_default_backend.sh update backend setup script 6 лет назад

README.md

develop branch status: Build Status Coverage Status Scrutinizer Code Quality

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

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

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: admin@admin.admin
  • password: admin@admin.admin

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.

./install_cypress.sh

Run tests with command line

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

Run tests with cypressgui

Open Cypress with graphical interface

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