Development

DreamTime is open-source and anyone can contribute to their code, improve it, implement ideas or create their own version for private or public use (respecting the license).

info

This document contains the instructions to prepare the user interface code (DreamTime), for the AI ​​algorithm code visit this page.

Repositories

DreamTime source code is hosted in these places:

info

If you are planning to contribute with a Pull Request please do it on GitHub by forking the canary branch.

Requirements

Experience

It will be easier for you to work with the code if you have experience in:

Setup

All the source code is in the src folder, this instructions are based on that folder.

Directory Structure

DirectoryDescription
buildFiles used by electron-builder.
electron"Backend" code, must be compiled with Babel.
modulesCode and utilities out of the scope of NuxtJS.
patchesMonkey-patches
scriptsExternal scripts.
OthersSee NuxtJS Directory Structure.

Dependencies

Install the project dependencies running this command:

yarn install

Development enviroment

Run the following commands to start the dev environment, once prepared you will have the DreamTime window, the DevTools and hot-reload ready.

yarn run dev:nuxt

yarn run dev:babel

yarn run dev:electron

info

If you are using Visual Studio Code you can run the task Build to open the first two commands in parallel terminals and press F5 to run the last command and open the DreamTime window.

Scripts

These are the commands that you can run with yarn run <command>:

CommandDescription
postinstallExecuted automatically when running yarn install. Responsible for running patch-package to apply monkey-patches to some libraries.
lintRun eslint to validate that the code complies with our syntax.
testShould run a series of tests to verify that the project works as it should, but these tests have not been created. 🤡
cleanDelete folders with compiled code.
deployRun @dreamnet/deploy to upload the release executable to multiple file providers.
optimizeRun modclean to clean the node_modules folder and decrease the size of the executable.
dev:env
dev:nuxtRun the NuxtJS development server with hot-reload.
dev:babelCompile the electron folder with hot-reload.
dev:electronOpen Electron using the compiled code from the previous command.
dev:build
build:env
build:nuxtCompile the NuxtJS code.
build:babelCompile the electron folder.
build:electronCreate a ready-to-distribute executable.
buildCompile the NuxtJS code, the electron folder, and create a ready-to-distribute executable.
preview:electron
preview:production