brain-web.github.io

A permanent space for the community to be together online, meet&matcha, work&watermelon, catch up&coffee.

See you in our next community call! :)

Propose a project

If you want your project to be listed on the BrainWeb project page, all you need to do is to create a repository on GitHub and to add brainweb as a topic to the repo. It will then automatically be featured in the BrainWeb project pool on the website.

Each project appears with the repo's title and description, and is linked to its GitHub repo. We also add a link to your website if you specify one in your README, and to your Mattermost channel for communication on your project. See below if you'd like to create a channel and indicate it in your README. We also get the number of stars and issues for your project, and which programming language it uses.
If you do not have an image in your README, your project will be shown with a randomly generated pattern image. These patterns are lovely, but in case you'd prefer an image that shows what the project is about, here are our recommended guidelines:

Create an image that shows in small format of dimensions 300px x 200px what you'd like to show --> save it as yourproject_card.jpg (small format is important so it doesn't slow the BrainWeb website down as number of projects will grow. ;)
Add an image to your repo.
Click on the image to get its link (right click on image --> open in new tab --> copy browser url).
paste this link into your README file (either visible so like ![](https://github.com/brain-web/brain-web.github.io/raw/master/images/readme/brainweb_card.jpg) or invisible as a comment (like this (which we recommend as we create a small image for the card and don't show this one in the readme, but show a bigger image there :)

Sidenote: The comment may not be visible depending on your Markdown renderer. You could open this README in Raw mode on GitHub to see the comment.

Your image will automatically show in the BrainWeb webpage

Note: BrainWeb takes the first linked image it finds in your README file. So you could potentially make the small version invisible at the top of your README, and add a link to a larger image for your README itself.

You are self conscious about the quality of the code in your project?

You have this nice project you are working on, but you are keeping the repo private because you think it is poorly coded. We understand. Many of us never got the training on how to code properly.

Get in touch with us on mattermost and we could arrange to help you go through your code and gain enough confidence to make your code public and this way find potential new collaborators.

You think that you won't be able to lead a team of several people to work on your project?

Yup. Some of us have been there too. Come and chat with us, and we will tell you what we learned and how we can help you get started with this.

Presenting your project

At our regular meetings, you will get the chance to present your project to other attendees. so here are some guidelines for our project pitch.

keep it short (definitely less than 5 minutes). This is short but there will be time at every meeting for people who are interested to come and ask you questions if they want to know more.
if you are too shy, you can record your pitch beforehand if you want, or get in touch with us if you want some one-on-one feedback.
tell us why you are passionate about this project
mention what concrete goals you want to achieve through this hackathon
let people know what type of skills (coding, design, documentation, testing etc.) you are looking for. You can get some inspiration from this template

Remove a project

If you remove the brainweb topic from your repo, it will no longer appear on the BrainWeb project page.

How to help

Our wish list

Below are some of the ideas that we thought we could implement in this project. Maybe you want to help us make them real. Or maybe you have your own suggestions, so come and chat with us on mattermost or open an issue.

create a blog with regular posts ; eventually turn it into a newsletter where we present each other's projects
improve the network visualization on the community page (add filtering options based on skills, vizualize only sub-networks, select users by color-coding, add a chat...)
implement some matching process between the skills required for a project and the skills of the users in the BrainWeb community
integrate a bot with our @TheBrainWeb twitter account to let every know that there is a new project listed on the BrainWeb

Skills required

If you want to help with the website of the BrainWeb project you will need to be familiar with a bit of:

git & github
html
css

Moreover some of the more advanced functions require some knowledge of one or several of the following:

Firebase
Javascript
Quasar
Vue.js
D3

Organisation of the website

We use Google Firebase for the database for our users. It allows us to create on the fly the network for the BrainWeb community page every time a new skill is added.

Network visualisation

The network visualisation is implemented in the community page in community/index.html and uses observables based on the D3 library for visualising the graph. This allows for quick and easy changes in visualisations.

There are currently two pruning functions implemented which make that from each node, only links to the 3 people with most skills in common will be shown. Groups result from a hierarchical clustering based on the skills in common. The maximum number of clusters is 12.

How to run the website locally

Fork & Clone the BrainWeb repo
Run an http server from inside that directory (we use https://www.npmjs.com/package/http-server)

Create an account on Firebase and put your credentials into the file init-firebase.js.

Suggesting changes

If you want to propose some changes: come and chat with us on mattermost or open an issue.

Before implementing your changes, please make a new branch, and then send us a pull request with your changes. This gives us the opportunity to see it in action and the possibility to suggest adaptations, before merging the pull request into the master branch.