coala / projects

A website that showcases interesting projects, using Angular JS.

Projects

A website that showcases projects! If you want to use it and it's not exactly fitting your purpose, please do make upstream changes. We expect this project to be of use to others and we're happy to make it more generic so it's easier to adapt to other organizations. This was built by coala community, to view live projects visit projects.coala.io

(It'd be nice to have an organization YML or so e.g.)

Purpose

This is designed for GSoC but can be used for other initiatives at the same time. We use it for research theses, GSoC, GCI and maybe others in the future.

Why?

• It's way more appealing to students.
• You can search and filter projects.
• Project ideas as structured data are more concise and you're sure to have all points covered - at the same time we can show students an overview and showing the full information only when needed.
• A proper review process can be used for triaging and iterating on project ideas.
• Stop wasting time maintaining a mentors list. This can be generated from the projects.

Usage

Dependencies

1. Install asdf-vm for your OS.

2. Using asdf-vm, install ruby.

3. Install Jekyll

    $ gem install jekyll bundler
   

Clone and Run

Clone coala Projects repository

$ git clone https://github.com/coala/projects.git

Run coala Projects website

$ cd projects
$ bundle install
$ bundle exec jekyll serve

Then you can simply go to either of the following addresses in your browser to access the site:

127.0.0.1:4000
localhost:4000

If you face problems while installing Jekyll or using its gem bundler you may go through its troubleshooting docs

Defining Projects

Mentors and admins can define projects in markdown using the following structure and save it in the _projects folder with a relevant filename. A sample project definition is available here

Defining FAQs

Users can also add FAQs by simply creating a markdown file in _faq folder.

Format for faq markdown file is as follows:

---
Question: <Write the question here>
---

Answer

Multi Language Support

coala Projects supports multiple 'human languages'. To add a translation of a project in a language, the following steps can be followed:

• Create a folder with language code in data/locale folder.
• Create faq.json, projects.json, faq and projects folder if they do not exist already.
• Add translated content of a project inside projects folder. The names of the files should be the same.
• Similarly translated content of a faq goes inside data/locale/ < language-id > /faq folder.
• For the faq.json and projects.json metadata, refer to Bahasa and Hindi Translations available in data/locale directory.
• Lastly, in resources/js/app.js file, Add the new language json in Language service.

projects's Issues

Related "Issues" not shown in project details popup

Alignment in card titles

Its aligned towards right, this should be in center

Limit line length

Reading the QA section with lines as long as my 24" screen is wide is hard

Add coafile

Don't uppercase so much

E.g. the requirements themselves shouldn't be uppercased

Add deployment instruction in README

Add folded questions, FAQ

Drop home page

Remove center tag

@hemangsk center is deprecated, the whole home.html looks very weird and not at all clean. E.g. you use col-md-6 and col-md-5 those two don't add up to 12 :P

The coala logo + coala text at the bottom is a little bit to the right

MUH OCD IS TRIGGERED!

Use a better title

Just "coala"? :P

Monospace font for mentor user IDs

Deploy to GitHub Pages

@hemangsk ping me when there's something pushed so I can trigger the deployment

Convert FAQs to a dict data structure

faq.js file should have format like
{
"ques" : "answer",
"ques" : "answer"
}

Use a pointer cursor when I hover over project cards

Didn't know they were clickable!

Get rid of all errors and warnings in the chrome dev console

Make the whole mentor card clickable

Not just the user IDs. Oh, and let's have a pointer cursor :)

the bullets on li's seem a bit far on the left

Opened via gitter by @sils

Add google analytics

Visualize base data

Show cards with name and description at least

Flesh out descriptions

Generally the descriptions of the projects in here aren't well enough and could be more verbose. The ideas need to be fleshed out.

mentors: Improve heights of mentor boxes

Don't use 100% width when the screen is wide

maybe have a 800px threshold beyond which the body is limited to, say, 600px

Extend Linter Integration: Project description not really up-to-date

It's too unspecific and Lint doesn't exist any more.

What I can think of is GlobalBear integration, though NiklasMM is currently working on it.

Link GitHub nicknames on mentors list

Add projects data structure

Markdown Support for Description and other stuff

Add milestone aliases

I'd like to be able to define a "GSoC 2017 Midterm" milestone that has a date associated with it once and then being able to define my milestones like "GSoC 2017 Midterm": [...] and not repeat the date every time

Have a JSON and MD file per project

It'd be nice to write the main description of a project as a markdown file and to have an own JSON per project. So we'd have e.g. improve_diffs.json with all the data and improve_diffs.md with the description.

Allow Gitbook to edit markdown

As part of #51 , it would be good to trial editing using gitbook.

I have created
https://www.gitbook.com/book/coala/projects/
But dont have rights to add the hook to sync the content.

Make tabs clickable

Link mentors in projects view to their github page

Text overflowing out of area

See image. Jayvdb is out of the project tab.

Add the following fields to the json

• Name (str)
• Mentors (list[str])
• Difficulty (low|medium|high)
• Requirements (list[str])
• Tags (list[str]) someting like core, plugins or so
• Initiative (list[str]) something like GSoC, RGSoC, GCI, Thesis
• Related issues, as URL (list[str])
• Description (str)
• Milestones (list of:)
  • Milestone (date, name, dict[list[str]: bool], so the student can make PRs to check the boxes)

Add a visible line under the search bar in the projects list

I didn't realize it's a search bar first :P

Search: filter as you type

Add initial files

This will include an index.html, css and js files.

Use text transformations properly

http://www.w3schools.com/cssref/pr_text_text-transform.asp

Paragraphs breaks don't work

I think this is meant to be a para break

Allow clicking cards to expand them

Remember tab state

If I ever want to link just to the list of projects. Maybe use that http://projects.coala.io/#projects or something like that?

Logo and text at the bottom interchange places on mobile

Wait, how's this possible?

And they're at the far extremes, not together, on mobile.

Tabs are too small on mobile

1080x1920 screen, 5-inches, Google Chrome for Android

Link mentor IDs to github profile

Gitter link should point to coala.io/chat

YML Config

So other orgs can use this

Bold doesn't get rendered

**text** isn't bold

Add mentors in Mentors tab

Add license

projects/mentors: Use colors matching with theme