81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
# The public Travis API
|
|
|
|
This is the app running on https://api.travis-ci.org/
|
|
|
|
## Requirements
|
|
|
|
You will need the following packages to get travis-api to work:
|
|
|
|
1. PostgreSQL 9.3 or higher
|
|
2. Bundler
|
|
3. Redis Server
|
|
4. *Optional:* RabbitMQ Server
|
|
5. Nginx -
|
|
*If working in Ubuntu please install nginx manually from source: Download and extract latest nginx version, open a terminal in extracted folder and then run the following:*
|
|
```sh-session
|
|
$ sudo apt-get install libpcre3 libpcre3-dev
|
|
$ auto/configure --user=$USER
|
|
$ make
|
|
$ sudo make install
|
|
$ sudo ln -s /usr/local/nginx/sbin/nginx /bin/nginx
|
|
```
|
|
|
|
## Installation
|
|
|
|
### Setup
|
|
```sh-session
|
|
$ bundle install
|
|
```
|
|
### Database setup
|
|
|
|
*You might need to create a role first. For this you should run the following:*
|
|
```sh-session
|
|
$ sudo -u postgres psql -c "CREATE USER yourusername WITH SUPERUSER PASSWORD 'yourpassword'"
|
|
```
|
|
|
|
NB detail for how `rake` sets up the database can be found in the `Rakefile`. In the `namespace :db` block you will see the database name is configured using the environment variable RAILS_ENV. If you are using a different configuration you will have to make your own adjustments.
|
|
```sh-session
|
|
$ RAILS_ENV=development bundle exec rake db:create
|
|
$ RAILS_ENV=test bundle exec rake db:create
|
|
```
|
|
#### Optional
|
|
Clone `travis-logs` and copy the `logs` database (assume the PostgreSQL user is `postgres`):
|
|
```sh-session
|
|
$ cd ..
|
|
$ git clone https://github.com/travis-ci/travis-logs.git
|
|
$ cd travis-logs
|
|
$ rvm jruby do bundle exec rake db:migrate # `travis-logs` requires JRuby
|
|
$ psql -c "DROP TABLE IF EXISTS logs CASCADE" -U postgres travis_development
|
|
$ pg_dump -t logs travis_logs_development | psql -U postgres travis_development
|
|
|
|
$ RAILS_ENV=test bundle exec rake db:create
|
|
$ pushd ../travis-logs
|
|
$ RAILS_ENV=test rvm jruby do bundle exec rake db:migrate
|
|
$ psql -c "DROP TABLE IF EXISTS logs CASCADE" -U postgres travis_test
|
|
$ pg_dump -t logs travis_logs_test | psql -U postgres travis_test
|
|
$ popd
|
|
```
|
|
|
|
|
|
### Run tests
|
|
```sh-session
|
|
$ bundle exec rake
|
|
```
|
|
### Run the server
|
|
```sh-session
|
|
$ bundle exec script/server
|
|
```
|
|
If you have problems with Nginx because the websocket is already in use, try restarting your computer.
|
|
|
|
## Contributing
|
|
|
|
1. Fork it
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
5. Create new Pull Request
|
|
|
|
### API documentation
|
|
|
|
v3 documentation can be found at https://developer.travis-ci.org which is a repository that can be found at https://github.com/travis-pro/developer
|