Tepoztecatl

Tepoztecatl is a simple open source API for optimal inventory control, developed with Ruby on Rails.

Setup

• PostgreSQL (>= 9.3)
• Ruby (>= 2.7.3)

After installing Ruby, open a terminal and run this command to install Bundler:

gem install bundler

Installation

To download and build the project, open a terminal and execute:

git clone https://github.com/huasteka/tepoztecatl.git
cd tepoztecatl
bundle install

To serve the project run: rails s the application will be served at http://localhost:9702.

Configuration

To configure database credentials modify config/database.yml file:

[environment]:
  <<: *default
  database: [database_name]
  username: [database_user]
  password: [database_password]

To run the database migrations, open a terminal and execute:

rake db:create
rake db:migrate

Tests

To execute all tests, open a terminal and execute:

bundle exec rspec

Run

To run the application, open a terminal and execute:

rails s

License

Tepoztecatl is Copyright © 2017 Huasteka.

It is free software, and may be redistributed under the terms specified in the LICENSE.md