https://github.com/ThoughtWorksInc/stonecutter

[Main repo found at https://github.com/d-cent/stonecutter] A D-CENT project: an easily deployable oauth server for small organisations.
https://github.com/ThoughtWorksInc/stonecutter

Last synced: 5 days ago
JSON representation

[Main repo found at https://github.com/d-cent/stonecutter] A D-CENT project: an easily deployable oauth server for small organisations.

• Host: GitHub
• URL: https://github.com/ThoughtWorksInc/stonecutter
• Owner: ThoughtWorksInc
• License: mit
• Created: 2015-06-15T12:38:52.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-01T09:51:23.000Z (over 8 years ago)
• Last Synced: 2024-08-01T12:19:32.895Z (3 months ago)
• Language: Clojure
• Homepage: https://sso.dcentproject.eu
• Size: 7.27 MB
• Stars: 9
• Watchers: 34
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Security: security.md

Awesome Lists containing this project

• awesome-starred - ThoughtWorksInc/stonecutter - [Main repo found at https://github.com/d-cent/stonecutter] A D-CENT project: an easily deployable oauth server for small organisations. (others)

README

        
# stonecutter

[![Build Status](https://snap-ci.com/d-cent/stonecutter/branch/master/build_image)](https://snap-ci.com/d-cent/stonecutter/branch/master)

A D-CENT project: an easily deployable oauth server for small organisations.

## Development VM

You can develop and run the application in a VM to ensure that the correct versions of Stonecutter's dependencies

are installed. You will need [VirtualBox][], [Vagrant][] and [Ansible][] installed.

First, clone the repository.

Navigate to the ops/ directory of the project and run:

    vagrant up development

The first time this is run, it will provision and configure a new VM.

When the VM has started, access the virtual machine by running:

    vagrant ssh

The source folder will be located at `/var/stonecutter`.

After initial setup, navigate to the source directory and build the assets with:

    cd /var/stonecutter

    gulp build

[Vagrant]: https://www.vagrantup.com

[Ansible]: http://docs.ansible.com/ansible/intro_installation.html

[VirtualBox]: https://www.virtualbox.org/

### Running

To start the app, run:

    ./start_app_vm.sh

To start a web server for the application in development mode, run:

    lein ring server-headless

NB: running the application like this will save users into an in memory cache that will be destroyed as soon as the app is shutdown.

### Running test suite

To run all tests, use this command:

```

lein test

```

Commands and aliases can be found in the project.clj file. 

### Running the prototype

Simply type:

```

gulp server

```

## Architecture

The Continuous Delivery build and deployment architecture is documented [here](https://docs.google.com/a/thoughtworks.com/drawings/d/1FZ35v27_pBym_NqzLbqVP_TwnHVBHNwFQss_Lzbs1bU/edit?usp=sharing).

The Hosting Architecture is documented [here](https://docs.google.com/a/thoughtworks.com/drawings/d/1mgdxe0Q0uYZloZLFLvlwyKRx4iUangEAn4aV2qm-zWs/edit?usp=sharing).

## Deployment

To deploy using Docker, see [here](docs/DOCKER.md).

To deploy to an Ubuntu server using Ansible, see [here](docs/UBUNTU.md).