Skip to content

README.md

Latest commit

 

History

History
52 lines (33 loc) · 1.46 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.46 KB

NativeAppTemplate API

This is a Rails API app for NativeAppTemplate-iOS/Android. To get started, clone the repository.

Requirements

You'll need the following installed to run the template successfully:

  • Ruby 3.3.5+
  • Node.js v20.17+
  • PostgreSQL 16+
  • Libvips or Imagemagick - brew install vips imagemagick
  • Overmind or Foreman - brew install tmux overmind or gem install foreman - helps run all your processes in development

If you use Homebrew, dependencies are listed in Brewfile so you can install them using:

brew bundle install --no-upgrade

Then you can start the database servers:

brew services start postgresql

Initial Setup

First, edit config/database.yml and change the database credentials for your server.

Run bin/setup to install Ruby and JavaScript dependencies and setup your database and seed initial data to the database.

bin/setup

Running NativeAppTemplate API on localhost

Replace the IP address 192.168.1.21 with your localhost IP address in Procfile.dev and config/environments/development.rb.

To run your application, you'll use the bin/dev command:

bin/dev

This starts up Overmind (or Foreman) running the processes defined in Procfile.dev. We've configured this to run the Rails server out of the box.

Contributing

If you have an improvement you'd like to share, create a fork of the repository and send us a pull request.