1
0
mirror of https://github.com/linkedin/oncall.git synced 2025-12-08 00:32:59 +02:00
Files
oncall/README.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2017-05-23 15:30:57 -07:00
Oncall [![Gitter chat](https://badges.gitter.im/irisoncall/Lobby.png)](https://gitter.im/irisoncall/Lobby) [![Build Status](https://circleci.com/gh/linkedin/oncall.svg?style=shield)](https://circleci.com/gh/linkedin/oncall)
2017-05-02 15:57:25 -07:00
======
2017-05-23 12:54:42 -07:00
<p align="center"><img src="https://github.com/linkedin/oncall/raw/master/docs/source/_static/demo.png" width="600"></p>
2017-05-18 16:08:37 -07:00
2017-05-23 12:54:42 -07:00
See [admin docs](http://oncall.tools/docs/admin_guide.html) for information on
how to run and manage Oncall.
2017-05-18 16:08:37 -07:00
2017-05-23 12:54:42 -07:00
Development setup
-----------------
### Prerequisites
2017-05-02 15:57:25 -07:00
2017-05-05 21:07:23 -07:00
* Debian/Ubuntu - `sudo apt-get install libsasl2-dev python-dev libldap2-dev libssl-dev`
### Install
2017-05-02 15:57:25 -07:00
2017-05-23 12:54:42 -07:00
```bash
2017-05-02 15:57:25 -07:00
python setup.py develop
2017-07-12 18:14:52 -07:00
pip install -e .[dev]
2017-05-02 15:57:25 -07:00
```
Setup mysql schema:
2017-05-23 12:54:42 -07:00
```bash
2017-05-02 15:57:25 -07:00
mysql -u root -p < ./db/schema.v0.sql
```
Setup app config by editing configs/config.yaml.
2017-05-23 12:54:42 -07:00
Optionally, you can import dummy data for testing:
```bash
2017-05-23 21:36:36 -07:00
mysql -u root -p -o oncall < ./db/dummy_data.sql
2017-05-23 12:54:42 -07:00
```
2017-05-02 15:57:25 -07:00
2017-05-23 12:54:42 -07:00
### Run
2017-05-02 15:57:25 -07:00
One of the following commands:
* `goreman start`
* `procman start`
* `make serve`
* `oncall-dev ./configs/config.yaml`
2017-05-02 15:57:25 -07:00
2017-05-19 18:07:35 -07:00
2017-05-23 12:54:42 -07:00
### Test
2017-05-02 15:57:25 -07:00
```bash
2017-05-02 15:57:25 -07:00
make test
```
2017-05-23 12:54:42 -07:00
Check out https://github.com/linkedin/oncall/issues for a list of outstanding
issues, and tackle any one that catches your interest. Contributions are
expected to be tested thoroughly and submitted with unit/end-to-end tests; look
in the e2e directory for our suite of end-to-end tests.