Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove sudo from docker-compose commands #75

Merged
merged 2 commits into from
Feb 8, 2022
Merged

Remove sudo from docker-compose commands #75

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a36fd5
Remove sudo from docker-compose commands
anetteu Feb 8, 2022
d606f9f
Add contributing guidelines
anetteu Feb 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Flotilla

Flotilla is the main point of access for operators to interact with multiple robots in a facility. The application
consists of a [frontend](frontend/README.md) in React, a [backend](backend/README.md) in Python using the FastAPI
framework and a Mosquitto MQTT Broker.
consists of a [frontend](frontend) in React, a [backend](backend) in Python using the FastAPI
framework and a Mosquitto MQTT [Broker](broker).

## Setup

Expand All @@ -12,6 +12,8 @@ For development, please fork the repository. Then, clone the repository:
git clone https://github.com/equinor/flotilla
```

Please see separate installation and setup guides for [frontend](frontend), [backend](backend), and [Broker](broker).

## Run with docker

Install docker using the [official documentation](https://docs.docker.com/engine/install/ubuntu/).
Expand All @@ -26,17 +28,23 @@ sudo apt install docker-compose
Build the docker container:

```
sudo docker-compose build
docker-compose build
```

Start Flotilla by running:

```
sudo docker-compose up
docker-compose up
```

or

```
sudo docker-compose up --build
docker-compose up --build
```

## Contributing

We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. The preferred way of submitting a contribution is to either make an [issue](https://github.com/equinor/isar/issues) on github or by forking the project on github and making a pull requests.

We write our commit messages according to [this guide](https://cbea.ms/git-commit/).