Skip to content

Latest commit

 

History

History
138 lines (85 loc) · 4.01 KB

README.md

File metadata and controls

138 lines (85 loc) · 4.01 KB

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

For development installation -

    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

        ```

        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

Steps for 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

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