Skip to content

aadarshsingh191198/Collaboration-System

 
 

Repository files navigation

License: GPL v2 CodeFactor Build Status

COLLABORATION SYSTEM

    Requiremnets -

            Django - 1.11.7 LTS
            python - 3.6
            Django Rest API
            Mysql

    Django pakages installed -

            Django Rest Framework
            Widget Tweaks
            Django Reversion
            Reversion Compare
            MPTT
            Haystack
            Django Machina
            Django-cors-headers
            Django-role-permission
            Django_comments_xtd
            Django_comments
	Django_wiki

For development installation (Virtual Environment) -

  1. Install virtualenv

    	sudo pip3 install virtualenv 
  2. Clone the project from github

    	git clone https://github.com/fresearchgroup/Collaboration-System.git 
  3. Create a virtual env ---

     	virtualenv collab -p python3 
  4. Activate the virtual environment --

    	source collab/bin/activate
  5. Install the requirements.txt --

    	pip3 install -r Collaboration-System/requirements.txt
  6. Install mysql server --

    	$ sudo apt-get update
    	
    	$ sudo apt-get install mysql-server
    
    	$ sudo apt-get install libmysqlclient-dev
    
        $ mysql -u root -p
    
        Enter password=root
    	
    mysql> create database collaboration;
        mysql> use collaboration;
        mysql> source collab.sql   
    
  7. Create a .env inside CollaborationSystem and paste the following -

       		sudo nano .env
        SECRET_KEY=myf0)*es+lr_3l0i5$4^)^fb&4rcf(m28zven+oxkd6!(6gr*6
        DEBUG=True
        DB_NAME=collaboration
        DB_USER=root
        DB_PASSWORD=root
        DB_HOST=localhost
        DB_PORT=3306
        ALLOWED_HOSTS= localhost
        GOOGLE_RECAPTCHA_SECRET_KEY=6Lfsk0MUAAAAAFdhF-dAY-iTEpWaaCFWAc1tkqjK
        EMAIL_HOST=localhost
        EMAIL_HOST_USER=
        EMAIL_HOST_PASSWORD=
        EMAIL_PORT=25
        EMAIL_USE_TLS=False
        DEFAULT_FROM_EMAIL=collaboratingcommunity@cse.iitb.ac.in
        SOCIAL_AUTH_GOOGLE_OAUTH2_KEY=735919351499-ajre9us5dccvms36ilhrqb88ajv4ahl0.apps.googleusercontent.com
        SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET=I1v-sHbsogVc0jAw9M9Xy1eM
    	LOG_TYPE=TOSERVER
    	LOG_PROTOCOL=http
    	LOG_ADDRESS=logstash
    	LOG_PORT=5000
    	LOG_STORE=debug.log
    	LOG_USE_PROXY=False
    	URL_BASIC=http://localhost:8000/
    	PAGE_SIZE=1000
    	MAX_PAGE_SIZE=10000
    	EVENTAPI_TOKEN_USERNAME=eventloguser
    	EVENTAPI_TOKEN_PASSWORD=eventlogpass
    	EVENT_API_TOKEN=
    	ELASTICSEARCH_ADDRESS=
    	
    	NODESERVERURL=http://localhost
    	NODESERVERPORT=9001
    	COLLAB_ROOT=http://localhost:7000
    	H5P_ROOT=http://localhost:8000
    	APIKEY=ae0135343b703000e7377f8438e5f1154dcdc2ffc434268729203764cfe28b26
    
  8. Do all the migrations --

    	python3 manage.py migrate
  9. Runserver --

    	python3 manage.py runserver

For manual installtion -- https://fresearchgroup.github.io/docs-collaboration-system/

For automated installation using nginx and gunicorn- https://github.com/abhisgithub/django-nginx-installation-script

For development installation (Docker) -

-- Install Docker and Docker-Compose from --

    Docker - https://docs.docker.com/install/linux/docker-ce/ubuntu/#set-up-the-repository

    Docker Compose -- https://docs.docker.com/compose/install/
  1. Clone the repository --
   	git clone https://github.com/fresearchgroup/Collaboration-System.git
  1. The run the following commands inside the repository --

    
    	docker-compose build
    
    	docker-compose up db
    
     	docker exec -i <container-image-name> mysql -u<username> -p<password> django < collab.sql
    
    	docker-compose run web python manage.py migrate
    
    	docker-compose run web python manage.py createsuperuser
    
    	docker-compose run web python manage.py loaddata workflow roles faq
    
    	docker-compose up
    

Event Logging

To set-up event logging for this system, please refer to the installation steps given in the repository link given below: https://github.com/fresearchgroup/Collaboration-System-Event-Logs

Interactive Content (H5P) and Real-time editing

To create and edit interactive content (H5P) and to enable real-time collaborative editing of articles, please refer to the installation steps given in the repository link given below: https://github.com/fresearchgroup/Community-Content-Tools

Recommendation System

This system is used to recommend articles based on his/her activity in the sytem. Please refer to the installation steps given in the repository below: https://github.com/fresearchgroup/Community-Recommendation

Etherpad

  1. Clone the following directory:

    	git clone http://github.com/dhanushsr/etherpad-lite
    	cd etherpad-lite/
    	./bin/run.sh
    
  2. Install PyEtherpadLite--

     	git clone http://github.com/dhanushsr/PyEtherpadLite
     	cd PyEtherpadLite
     	python setup.py install
     	cd ..
    
  3. Paste the apikey from APIKEY.text from etherpad-lite folder in the .env.example file

  4. Create a .env inside CollaborationSystem and paste the following -

     	sudo cp .env.example .env
    
  5. Do all the migrations going back to django directory--

       python3 manage.py migrate
    
  6. Runserver --

      python3 manage.py runserver  
    

About

A system for collaboration

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 27.7%
  • HTML 21.3%
  • JavaScript 20.5%
  • TSQL 16.1%
  • CSS 14.3%
  • Dockerfile 0.1%