Open Badge Passport community edition
Clojure CSS HTML JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
resources merge ims-certification branch Aug 16, 2018
src
test
test_old Add new testing structure Feb 28, 2017
.gitignore
.midje.clj
LICENSE Whitespace, readme Oct 16, 2015
README.md documentation update Nov 29, 2017
badge.pdf generate PDF Mar 23, 2018
project.clj Bump version Aug 14, 2018

README.md

salava

Open Badge Passport community edition

Open Badges is an open standard developed by the Mozilla Foundation to recognize, validate and demonstrate learning that happens anywhere. Open Badges are digital credentials, created and issued by organizations such as schools, vocational organizations, companies and employers for their students, members, staff, clients or partners.

Open Badge Passport is a platform for badge earners to easily receive, save and organize their Open Badges and share them on social media such as LinkedIn, Twitter and Facebook. Salava (this project) is the open source implementation of the currently running proof-of-concept. Our first goal is to have the same feature set and then build on that.

Quickest way to see what this project is about is to create an account in Open badge Passport (it's free) and play around with that.

Quick start

The project is still in its early stages and not really suitable for any real use. Still, you can try it out.

The code is known to work with Ubuntu Linux, Oracle Java 8 and MariaDb 10. We use Leiningen as dependency manager. For building scss files you need a sass compiler, such as sassc. On OS X you can use Homebrew:

Install sass compiler

MacOS Users

$ brew install sassc

Linux Users -- a system installation of sassc is recommended

1 Install libtool

apt-get install autotools-dev autoconf libtool # Alpine
yum install automake libtool # RedHat Linux

2 Get sources # using git is preferred

git clone https://github.com/sass/libsass.git
git clone https://github.com/sass/sassc.git

3 Compile LibSass

  #Create configure script

    cd libsass  #navigate to libsass repo
    autoreconf --force --install
    cd ..

  #then create custom makefiles

    cd libsass
    ./configure \
    --disable-tests \
    --enable-shared \
    --prefix=/usr
    cd ..

  #Then build the library

    make -C libsass -j4

  #Install the library

    make -C libsass install

4 Compile SassC

  #Create configure script

    cd sassc  #navigate to libsass repo
    autoreconf --force --install
    cd ..

  #then create custom makefiles

    cd sassc
    ./configure \
    --enable-shared \
    --prefix=/usr
    cd ..

  #Then build the library

    make -C sassc -j4

  #Install the library

    make -C sassc install

  #Check if compiler installed properly

    sassc --version

Install the database.

#MacOs
  $ brew install mariadb

#Linux
  $ sudo apt-get install mariadb-server

Start the database:

#MacOS
  $ mysql.server start

#Linux
  $ sudo mysqld

Create the database:

$mysql -u root -p
>create database salava;
>create database salava_test;
>create user 'salava'@'localhost' identified by 'salava';
>grant all privileges on salava.* to 'salava'@'localhost';
>grant all privileges on salava_test.* to 'salava'@'localhost';
>quit

Create your config files for development and testing:

$ cp resources/config/core.edn.base resources/config/core.edn
$ cp resources/test_config/core.edn.base resources/test_config/core.edn

Edit the files and add your db settings etc.

Create a directory to store files that are uploaded or created by Salava. Add the directory to the config file (keyword :data-dir).

After that:

# Initialize your db and insert some sample data
$ lein migrator-reset

# Build translation files
$ lein translate

# Start figwheel, cljsbuild and scss compiler
$ lein develop

# (in another terminal)

# Start application server
$ lein repl
# ...
user=> (go)

# Load test config and run all tests
user=> (toggle-test-mode)
user=> (run-tests)

# Switch back to development mode
user=> (toggle-test-mode)

TODO

  • OAuth (Google)
  • Full text search
  • Admin tools
  • Fix existing tests
  • More tests

License

Copyright (c) 2015-2017 Discendum Oy and contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.