https://github.com/enricofer/barney_document_versioning

a django app for simple versioning of markdown text contents
https://github.com/enricofer/barney_document_versioning

collaboration django dms jwt legal legal-documents nuxt version versioning vue

Last synced: 7 months ago
JSON representation

a django app for simple versioning of markdown text contents

Host: GitHub
URL: https://github.com/enricofer/barney_document_versioning
Owner: enricofer
License: gpl-3.0
Created: 2020-09-18T12:31:53.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2022-10-10T11:20:35.000Z (almost 3 years ago)
Last Synced: 2025-01-07T10:46:38.730Z (9 months ago)
Topics: collaboration, django, dms, jwt, legal, legal-documents, nuxt, version, versioning, vue
Language: Python
Homepage:
Size: 23.8 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

![](https://api.travis-ci.com/enricofer/barney_document_versioning.svg?branch=master) ![](coverage.svg)

# barney_document_versioning
a django app with vue frontend for easy collaborative versioning of markdown text contents

![](docs/bvs1.png)

### Backend installation

install pandoc package,

```
sudo apt update
sudo apt install pandoc
```

open a terminal Clone the repository,

```
git clone https://github.com/enricofer/barney_document_versioning.git
cd barney_document_versioning
```

Creato settings file from default and edit BARNEY_CONFIG as needed,

```
cp settings_default.py settings.py
nano settings.py
```

then,

```
pip install -r requirements.txt
```

```
python manage.py migrate
```

```
python manage.py createsuperuser
```

```
python manage.py runserver
```

now a development server should run on localhost on port 8000

open the already builded frontend app with the following url:

```
http://localhost:8000/version/
```

### Frontend installation

Frontend app could be run from npm. In this case you have to open a new terminal from the same directory and move to frontend directory

```
cd frontend
```

now install javascript modules

```
npm install
```

and run a development app on localhost at port 3000

```
npm run dev
```

or build the new frontend app (the build files are copied to `version/static/version/frontend` directory)

```
npm run build
```