CollaCode

collacode-tour.webm

Description

CollaCode is a web-based tool for collaborative coding. See GitHub Pages for a (limited) demo.

To get a full demo you can visit https://www2.visus.uni-stuttgart.de/collacode/.

Table of Contents

• CollaCode
  • Description
  • Table of Contents
  • Installation
  • Usage
  • Contributing
  • License

Installation

Download the code from this repository.

To setup the frontend, simply install the required node packages using the package manager of your choice.

# setup with npm
npm install

# setup with yarn
yarn install

For the backend, you need to install the packages listed in environment.yml, for example using conda.

conda env create -n <name>  -f environment.yml

Then you need to create a config file for the backend server. You may use the file config_template.py as a guide.

DATABASE_PATH = "SET YOUR DATABASE FILENAME HERE"
SECRET_KEY = "SET YOUR SECRET KEY HERE"
SESSION_COOKIE_DOMAIN = "SET YOUR SESSION COOKIE DOMAIN HERE"
REMEMBER_COOKIE_DOMAIN = "SET YOUR REMEMBER COOKIE DOMAIN HERE"
REMEMBER_COOKIE_PATH = "/"
REMEMBER_COOKIE_SECURE = False
DEBUG = False
MAX_CONTENT_LENGTH = 5 * 1024 * 1024

To prepare the SQL database for the backend, you can use caribou and the migration scripts provided in backend/migrations. Simply create an empty SQL database and run the following command.

caribou upgrade <database-path> migrations

As of now, new users need to be created manually via command line. To do so, you need to run the add_user.py script like so:

python add_user.py "username" "password" [-r "admin|collaborator"] [-e "my@email.com"]

If you do not specify a role, the user will be added as a collaborator.

Usage

CollaCode uses the standard VITE server for the frontend and a flask server for the backend. To use the out-of-the-box solution, simply start both serves like so:

Debug Configuration

# backend flask server
# set DEBUG = True in config.py
cd backend
python server.py

# frontend dev server using npm
npm run dev

# frontend dev server using yarn
yarn dev

Production Configuration

# backend flask server
# set DEBUG = False in config.py
cd backend
python server.py

# frontend dev server using npm
npm run build
npm run preview

# frontend dev server using yarn
yarn build
yarn preview

Contributing

If you find any bugs feel free to create an issue.

License

This project is licensed under the MIT License.