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).
This document contains the instructions to prepare the user interface code (DreamTime), for the AI algorithm code visit this page.
DreamTime source code is hosted in these places:
If you are planning to contribute with a Pull Request please do it on the canary branch.
It will be easier for you to work with the code if you have experience in:
- SCSS: CSS Preprocessor.
- TailwindCSS: CSS Framework.
- Electron: Software used to "transform" DreamTime from a website to a desktop application.
All the source code is in the
src folder, this instructions are based on that folder.
|Files used by electron-builder.|
|"Backend" code, must be compiled with Babel.|
|Code and utilities out of the scope of NuxtJS.|
|Others||See NuxtJS Directory Structure.|
Install the project dependencies running this command:
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
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.
These are the commands that you can run with
yarn run <command>:
|Executed automatically when running |
|Run eslint to validate that the code complies with our syntax.|
|Should run a series of tests to verify that the project works as it should, but these tests have not been created. 🤡|
|Delete folders with compiled code.|
|Run @dreamnet/deploy to upload the release executable to multiple file providers.|
|Run modclean to clean the |
|Run the NuxtJS development server with hot-reload.|
|Compile the |
|Open Electron using the compiled code from the previous command.|
|Compile the NuxtJS code.|
|Compile the |
|Create a ready-to-distribute executable.|
|Compile the NuxtJS code, the |