DAW version control

DAW is a CLI client for DAW project file version control.

Getting Started

Follow these instructions to build and install daw version control

Pre-requisites

Go

The CLI client is written and built with Golang. Download the latest version of Golang here.

Python

Python is used to handle API requests and interface with the database. Download the latest version of Python here.

Git

Git is used to manage the codebase. Download the latest version of Git here.

Installation & Running

Getting started with daw version control...

1. To Start, clone the Daw repository from GitHub, change into the Daw directory, and checkout the master branch.

   git clone https://github.com/grayson40/daw-version-control.git
   cd daw-version-control
   git checkout master
   

   Working off the master branch will ensure that you're using the latest released version of Daw.

2. Build and install the CLI module.

   go build
   go install
   

3. Setup python virtual environment. Download dependencies.

   cd api
   pip install pipenv
   pipenv sync
   

   The next set of commands need to be executed in a unix shell (i.e. git bash).

4. Spin up flask server to handle API requests.

   cd api
   chmod +x bootstrap.sh
   ./bootstrap.sh
   

5. You are now ready to use the daw version control tool.

Available Scripts

With the module installed, you can run:

add

Add the project file(s) to be tracked.

Example:

daw add <file>...

commit

Commit staged project file(s) with a specified message.

Example:

daw commit <message>

push

Push the staged commits up the current ref.

Example:

daw push

status

Displays paths that have differences between the index file and the current HEAD commit

Example:

daw status