Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-cent/stonecutter
A D-CENT project: an easily deployable oauth server for small organisations.
https://github.com/d-cent/stonecutter
Last synced: about 1 month ago
JSON representation
A D-CENT project: an easily deployable oauth server for small organisations.
- Host: GitHub
- URL: https://github.com/d-cent/stonecutter
- Owner: d-cent
- License: mit
- Created: 2016-03-14T10:51:46.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-11T15:54:50.000Z (almost 8 years ago)
- Last Synced: 2024-08-01T12:19:31.500Z (4 months ago)
- Language: Clojure
- Homepage:
- Size: 6.51 MB
- Stars: 34
- Watchers: 19
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: security.md
Awesome Lists containing this project
- awesome-starred - d-cent/stonecutter - A D-CENT project: an easily deployable oauth server for small organisations. (others)
README
# stonecutter
A D-CENT project: an easily deployable oauth server for small organisations.
> **There has been an update to the deployment script `deploy_prod.sh`. If you have deployed an instance of Stonecutter
to an Ubuntu server using Ansible, you will need to rerun the last two steps of the deployment:
[Configure with ansible](https://github.com/d-cent/stonecutter/blob/master/docs/UBUNTU.md#configure-with-ansible) and
[Deploy application to the server](https://github.com/d-cent/stonecutter/blob/master/docs/UBUNTU.md#deploy-application-to-the-server).**
## 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).