Create a Makefile to Dockerize the Application, Local Blockchain, and Database

[brolag]

Create a Makefile to automate the Dockerization process for the CofiBlocks application, the local Starknet blockchain, and a MySQL database. This will simplify the setup and execution of the project in a local development environment.

• Steps:

  1. Create Dockerfile for the Application:
     • Write a Dockerfile for the CofiBlocks application using Next.js (or the relevant stack).
     • Ensure the Dockerfile includes steps for installing dependencies, compiling the project, and exposing the required ports.
  2. Create Docker Compose File:
     • Write a docker-compose.yml file to spin up the CofiBlocks app, Starknet local blockchain, and MySQL database in separate containers.
     • Define services:
     • CofiBlocks App: The application service running on Node.js.
     • Starknet Local Blockchain: A local Starknet environment using starknet-devnet.
     • MySQL Database: A MySQL database container with necessary configurations (e.g., root password, database name).
  3. Configure Environment Variables:
     • Set up environment variables for database connection, Starknet devnet configuration, and the application.
     • Include .env file support in the docker-compose.yml and Makefile for dynamic configuration.
  4. Write Makefile to Automate the Process:
     • Write a Makefile to automate common tasks such as:
     • Building the Docker containers (make build).
     • Starting the application, local blockchain, and MySQL database (make start).
     • Stopping all containers (make stop).
     • Removing stopped containers and cleaning up (make clean).
  5. Ensure Database Persistence:
     • Ensure that the MySQL database persists data using Docker volumes, so data is not lost between runs.
  6. Testing the Setup:
     • Test the Dockerized setup by running the Makefile commands and ensuring all services (application, blockchain, and database) start up correctly and interact with each other.
     • Ensure the application connects to both the local Starknet blockchain and the MySQL database.
  7. Create Documentation:
     • Write detailed documentation in the project's README.md file for setting up the development environment using Docker and Makefile.
     • Documentation should include:
     • Prerequisites: Docker, Docker Compose, Make.
     • Setup Instructions:
       1. Clone the repository.
       2. Create a .env file (provide a sample .env.example with required variables such as database credentials, Starknet configs).
       3. Build and run the containers using the Makefile.
       4. Instructions for common commands (make build, make start, make stop, make clean).
     • Troubleshooting section: common issues during Docker setup and possible solutions.
  8. Provide Sample .env.example:
     • Create a sample .env.example file that includes placeholders for database credentials, Starknet local blockchain settings, and other environment-specific configurations.

• Acceptance Criteria:

  • The Dockerfile, docker-compose.yml, and Makefile are created and allow for a seamless setup of the CofiBlocks application, Starknet local blockchain, and MySQL database.
  • Running make build builds the Docker containers for all services.
  • Running make start successfully starts the app, local blockchain, and database.
  • Running make stop stops all containers.
  • Running make clean removes stopped containers and unused volumes.
  • A well-documented README.md file is added, explaining the setup process, commands, and troubleshooting tips.
  • The application can connect to the local blockchain and database without issues.

• Resources:

  • Docker Documentation
  • Docker Compose Documentation
  • Starknet Devnet
  • MySQL Docker Hub
  • Makefile Documentation

[jbmkahdeksan]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I've been working with several projects in the ecosystem, the knowledge acquiredcan be leveraged for good practices and quality for the task.

How I plan on tackling this issue

I will first make sure to setup everything correctly and understand how everything works as a whole. Then I will create the Makefile as requested.

[onlydustapp[bot]]

Hey @jbmkahdeksan! Thanks for showing interest. We've created an application for you to contribute to Cofiblocks. Go check it out on OnlyDust!

[rvalenciano]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I've experience dockerizing applications with Docker/Docker Compose and creating database scripts with seeds data so development can be streamlined and the project portable, easy to setup and to run within a couple of commands.

How I plan on tackling this issue

1. I'll create a Dockerfile inside the /apps/web folder where I install all packages that are needed for an alpine base image.
2. I'll create a Docker-Compose file inside the /apps/web with the required dependencies in the web application
3. Will research what is needed to Dockerize the starknet foundry so we can run the contracts locally without having to install anything.
4. Once the app is up and running, will add the proper documentation

[onlydustapp[bot]]

Hey @rvalenciano! Thanks for showing interest. We've created an application for you to contribute to Cofiblocks. Go check it out on OnlyDust!

[brolag]

@rvalenciano @jbmkahdeksan please team up and work on this.

[jbmkahdeksan]

@brolag have you seen this? TL;DR Starknet Devnet in Python is deprecated. Options are: Starknet Devnet in Rust or Starknet Devnet in JS (wrapper) cc. @rvalenciano

[brolag]

@brolag have you seen this? TL;DR Starknet Devnet in Python is deprecated. Options are: Starknet Devnet in Rust or Starknet Devnet in JS (wrapper) cc. @rvalenciano

Didnt' know it was deprecated. Should we try the JS version?

[jbmkahdeksan]

Didnt' know it was deprecated. Should we try the JS version?

We can, I am investigating about it. I've found that Rust version has an Docker image published, this is not the case for the JS, version. I not a 100% sure, but I think the JS version would run within the app, not as a separate container.

[rvalenciano]

I'm fine with either Starknet Devnet JS or Starknet Devnet Rust, feel comfortable in both languages. @brolag @jbmkahdeksan you can make the call. @jbmkahdeksan even if the JS image doesn't have a proper image, we can dockerize this if we just pull from the Node 18 or whatever version we want base image.

[jbmkahdeksan]

@falconcr hi! glad you joined, I've been studying this docker image that could be a good fit for our Starknet container, I couldn't make it work in my environment thou.