Skip to content

[Feature] Add build docs #32

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

Merged
merged 4 commits into from
Jul 17, 2021
Merged

[Feature] Add build docs #32

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8274d13
README.md: Add section: Running blowfisher
gmacario Jul 17, 2021
43d4ca6
Fix typo: blowfisher -> blowfishes
gmacario Jul 17, 2021
ef0fac6
Again! blowfishes -> blobfishes
gmacario Jul 17, 2021
3b2f93a
Add links to docker and docker-compose homepages
gmacario Jul 17, 2021
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
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,33 @@ The ugliest project participating to the [DigitalOcean MongoDB Hackathon](https:

If you need some inspiration, look at this blobfish!

## Running blobfishes

Prerequisites:

* [Docker](https://www.docker.com/) version 20.10.6 or later
* [Docker Compose](https://docs.docker.com/compose/) version 1.21.2 or later

Run the following command from a shell:

```bash
docker-compose up -d
```

### Rebuilding images from scratch

```bash
docker-compose up --build --force-recreate
```

### Local client development

```bash
cd client
npm install
npm run dev
```

## Communications

Use the [Telegram group](https://t.me/joinchat/SKXDx6mokoQ4MmVk)
Expand Down