band.it ·

OpenSource Music colaboration tool, band it!

On Band.it musicians can coolaborate and create music by joining tracks, publish albums and create new bands.

Installing / Getting started

You need to download repo to your disk. Then run all with docker-compose:

git clone https://github.com/band-its/band.it.git
cd band.it/
docker-compose up

The above commands are used to download the repository and run docker-compose. All images will be downloaded.

Developing

Built With

Backend:

• Spring Boot 2.1.3
• Gradle 5.2

Frontend:

• Angular 7.2
• Bootstrap 4.3 (with ng-boostrap)

Prerequisites

You need Java Development Kit 11 (OracleJDK or OpenJDK), NodeJS >10.15.3 and Docker installed.

Setting up Dev

Backend: Don't need to setting something up. Just use this to build all modules:

./gradlew build -x test

To build without tests add a -x test flag. You can also build

Frontend: You should have running the backend to start development of frontend. You can run it with docker-compose.

docker-compose up

Then go to the frontend module, install dependencies and you can start the app.

cd frontend/
npm install
ng serve

And state what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here.

Building

If your project needs some additional steps for the developer to build the project after some code changes, state them here. for example:

./gradlew build -x test
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build

Here again you should state what actually happens when the code above gets executed.

Deploying / Publishing

CircleCI will take care of this.

Links and ports to local services

Versioning

SemVer is used for Band-it versioning.

Configuration

TODO: Write about configuration of production / development application startup modes.

Tests

Describe and show how to run the tests with code examples. Explain what these tests test and why.

./gradlew clean check

E2E tests:

./gradlew testE2E

Style guide

Api Reference

API doc is deployed using Swagger2 and can be accessed under http://localhost/swagger-ui.html when backend services are running.

Database

Licensing

This project is licensed under the Apache 2.0 License - see the LICENSE file for details