ZumitoTeam / zumito-framework

Framework for creating a bot for discord
https://framework.zumito.dev
7 stars 1 forks source link

Feature dev container for development #31

Closed int0x80-sys closed 12 months ago

int0x80-sys commented 1 year ago

Hi :wave:

This pull request is for the feature discused in issue #30 . I add the necessary docker files and the devcontainer configuration to setup the development environment. As i mentioned in the issue, the requirements to use this features are:

With that requirements installed, you can open the project folder and:

All the plugins that will be installed in the container are specified in the devcontainer.json file. All the things placed under "customizations.vscode.extensions are the extensions installed in the container. And the attributes in customizations.vscode.settings are the global settings for vscode inside the container.

Another important thing in the devcontainer.json is the "runService" attribute. It's an array of all the services that must be run with the devcontainer. Here we can specify any service that are present in the docker-compose file.

This pull request is not meant to be approved at first. I want you to try this feature and give me feadback about it. Also, all the extensions that are installed are base on what i see you are using. So feel free to add or request to add more extensions that you find usefull to have in the container. And if i must to change the readme file to add the posibility of use this feature for development.

reviewpad[bot] commented 1 year ago

AI-Generated Summary: This pull request consists of the following changes:

  1. Git ignore for .env files was added which prevents these environment files from getting tracked in the repository.
  2. Docker and Docker compose files for the development environment were created. The Dockerfile begins with a base image of node, installs some necessary packages, and sets up a working directory. The docker compose file defines services to use different databases including MySQL, PostgreSQL, MongoDB, and CouchDB.
  3. An example .env file was added. This file holds environment variables for each of the database service. The user may fill in the example environment variables to set up their personal development environment.
  4. There's creation of a .devcontainer directory which includes Docker configuration settings for Visual Studio Code. This allows developers to define development environment settings within their container living within VS Code. This includes extensions to install and VS Code settings.
reviewpad[bot] commented 1 year ago

Thank you @int0x80-sys for this first contribution!

github-actions[bot] commented 1 year ago

Beta tag version created: 1.1.78. You can install it with npm install zumito-framework@1.1.78.

reviewpad[bot] commented 1 year ago

Reviewpad Report

:bangbang: Errors

:warning: Warnings