Annict
Contributing
Requirements
To run Annict on a local machine, you need to have the following dependencies installed:
- Docker
- Docker Compose
Running the app
$ git clone git@github.com:annict/annict.git
$ cd annict
$ touch .env.development.local
$ docker-compose build
$ docker-compose up
$ docker-compose exec rails bundle exec rake db:setup
You should then be able to open http://localhost:3000 in your browser.
Running the tests
$ docker-compose exec -e RAILS_ENV=test rails bundle exec rspec
License
Copyright 2014-2019 Annict
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.