blobfishes 🐡 🐡

Blobfishes aims to be the ugliest project participating to the DigitalOcean MongoDB Hackathon.

If you need some inspiration to be ugly, look at this blobfish!

Deploying blobfishes to DigitalOcean 🌊

Please see this document.

Running blobfishes 🐡 in Docker 🐳

Prerequisites

• 🐋 Docker version 20.10.6 or later
  • Make sure that Docker is configured to be managed as an ordinary (non-root) user. See https://docs.docker.com/engine/install/linux-postinstall/ for details.
• Docker Compose version 1.21.2 or later
• Credentials to connect to an existing MongoDB instance
  • For development purposes you may use a one-node instance running on your local Docker engine.

Create and run the containers

1. Check out the sources from GitHub.

2. Create file .env starting from the .env.example available in the repository and insert the credentials to connect to your MongoDB instance editing the lines which start with MONGODB_:

   cp .env.example .env
   vi .env

3. Run the following command from a shell to create and run the containers:

   docker-compose up -d

4. You may check the server logs with the following command (type Ctrl-C to stop):

   docker-compose logs -f

   You may inspect the logs of one or more specific services by appending their names to the docker-compose logs command; for instance:

   docker-compose logs server

5. To shut down the server run the following command

   docker-compose down

Rebuild the updated version of the Docker images

docker-compose build --pull --no-cache

Local client development

Prerequisites:

• Node.js version 14.17.3 or later

Run the following command from a shell:

cd client
npm install
npm run dev

How to submit bugs and/or questions

Please create issues under https://github.com/aquariophilie/blobfishes/issues.

For quick communications with the project maintainers use this Telegram group.

Copyright and License

Copyright (c) 2021 Gianpaolo Macario and the Aquariophilie team.

Blobfishes is released under an Open Source license; see LICENSE file for details.

The "blobfish-rounded" logo is a derivative of "blobfish-s400x244-2297-580" by jamasca66, used under CC BY-NC 2.0. "blobfish-rounded" is licensed under CC BY-NC 2.0.