Skip to content
A website that showcases interesting projects, using Angular JS.
JavaScript HTML CSS Python Ruby Liquid Shell
Branch: master
Clone or download

Latest commit

Shiva-sankaran and abhishalya writing_a_great_proposol.md: Update_GSOC_link
Changes the old broken link with the new link to
summerofcode.withgoogle.com

Closes #642
Latest commit ef99a10 Jan 16, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci
_faq writing_a_great_proposol.md: Update_GSOC_link May 17, 2020
_layouts resources\css\: Fix errors raised by CSSLintBear May 3, 2020
_projects _projects: Update GSoC'19 projects status May 3, 2020
_reports RohanVB report: Add missing fields May 6, 2020
data FAQ: Finish Indonesian translation Nov 3, 2018
partials/tabs projects.html: Add filters for searching projects Aug 26, 2019
resources resources\css\: Fix errors raised by CSSLintBear May 3, 2020
screenshots index.html: Add a navbar Aug 25, 2019
tools authorPatchCollector.py: Add GSOC patch collector Oct 26, 2018
.coafile .coafile: Add a new "css" section May 3, 2020
.editorconfig .editorconfig: Add new file Oct 12, 2018
.gitignore .gitignore: Sync Aug 22, 2019
.moban.yaml Use gitignore moban Jul 10, 2018
.ruby-version Use ruby 2.5.1 Aug 11, 2018
.rultor.yml rultor: Check maintainership before merging Jul 31, 2017
.travis.yml .coafile: Add a new "css" section May 3, 2020
404.html Add custom 404 page Aug 31, 2017
CNAME Create CNAME Jan 17, 2017
Gemfile Use ruby 2.5.1 Aug 11, 2018
Gemfile.lock Gemfile.lock: Update Aug 11, 2018
LICENSE Create LICENSE Jan 17, 2017
PULL_REQUEST_TEMPLATE.md Add pull request template Feb 6, 2017
README.md README.md: Remove trailing whitespace Aug 22, 2019
_config.yml index.html: Update footer design Aug 25, 2019
book.json Add internationalised GitBook support Nov 1, 2017
favicon.ico Add basic structure for website Jan 17, 2017
index.html projects.html: Add filters for searching projects Aug 26, 2019
netlify.toml Use ruby 2.5.1 Aug 11, 2018
reports.html students.html: Add a tab displaying GSoC Students Aug 25, 2019

README.md

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 file should be same.
  • Similiarly 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.
You can’t perform that action at this time.