Home

Welcome to the neurons.me wiki!

"dependencies": { "netget": "https://github.com/your-username/netget.git", "mLearning": "https://github.com/your-username/mlearning.git", "monads": "https://github.com/your-username/monads.git", "theVault": "https://github.com/your-username/thevault.git", "cleaker": "https://github.com/your-username/cleaker.git" }

The submodule directories (cleaker, mLearning, netget, theVault) will be located inside the neurons.me repository directory on your local machine, but when you push the changes to the neurons.me GitHub repository, only the references to the submodule repositories will be included, not the actual code of the submodules.

This setup allows users who install the neurons.me package to automatically download and install the submodules from their respective GitHub repositories, without the need to include all the submodule code in the neurons.me repository. It provides modularity and separates the development of each submodule, making it easier to maintain and update them independently.

Development Collaboration and Hard Core Customization:

Here's an explanation of the workflow for users who want to customize and use their own profiles of the neurons.me package:

Clone the neurons.me GitHub repository: Users should start by cloning the neurons.me repository to their local machine. This can be done using the git clone command and specifying the repository URL:

git clone https://github.com/your-username/neurons.me.git

Navigate to the cloned repository: Once the repository is cloned, users should navigate to the cloned neurons.me directory:

cd neurons.me

Customize the submodules:

Users can now customize the submodules according to their needs. For example, if they want to modify the netget module, they can navigate to the netget directory and make the necessary changes.

Create a branch for customizations:

To keep track of their customizations, users should create a new branch in the neurons.me repository. They can do this using the git branch command:

git branch my-custom-branch Switch to the custom branch: Users should switch to the newly created branch to work on their customizations:

git checkout my-custom-branch Push the custom branch to GitHub: After making the desired customizations, users can push the custom branch to their own GitHub repository. This can be done using the git push command:

git push origin my-custom-branch Update package.json: In the neurons.me directory, open the package.json file and modify the submodule dependencies to point to the user's custom GitHub repositories. For example, the netget dependency URL should be updated to the user's custom branch repository:

"netget": "https://github.com/your-username/netget.git#my-custom-branch" Publish the custom package: Finally, users can publish their custom package to the npm registry. They can use the npm publish command from the neurons.me directory to publish their customized package:

npm publish With this workflow, users can create their own branches for each submodule, customize the code according to their requirements, and update the package.json file to reference their custom branches. They can then publish their customized package to the npm registry or share it with others.

It's important to note that users should have the necessary permissions and ownership of the submodule repositories on GitHub to add them as dependencies and publish the customized package to the npm registry.