Skip to content

Commit 9df6b1e

Browse files
authored
Merge pull request #35 from nativeapptemplate/docs/fix-readme
update README for open source release
2 parents 9b08d2b + b75be94 commit 9df6b1e

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# NativeAppTemplate API
22

3-
This is a Rails API app for NativeAppTemplate-iOS/Android.
4-
To get started, clone the repository.
3+
A [Rails 8.1](https://rubyonrails.org/) API backend for NativeAppTemplate iOS/Android mobile applications. It's a multi-tenant SaaS application with token-based authentication, role-based authorization, and RESTful API endpoints.
4+
5+
For more information, visit [nativeapptemplate.com](https://nativeapptemplate.com).
6+
7+
## Related Repositories
8+
9+
### Paid Clients
10+
- [NativeAppTemplate-iOS](https://github.com/nativeapptemplate/NativeAppTemplate-iOS)
11+
- [NativeAppTemplate-Android](https://github.com/nativeapptemplate/NativeAppTemplate-Android)
12+
13+
### Free Clients
14+
- [NativeAppTemplate-Free-iOS](https://github.com/nativeapptemplate/NativeAppTemplate-Free-iOS)
15+
- [NativeAppTemplate-Free-Android](https://github.com/nativeapptemplate/NativeAppTemplate-Free-Android)
516

617
## Requirements
718

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

10-
* Ruby 3.3.5+
11-
* Node.js v20.17+
21+
* Ruby 4.0.2+
1222
* PostgreSQL 16+
13-
* Libvips or Imagemagick - `brew install vips imagemagick`
23+
* Libvips - `brew install vips`
1424
* [Overmind](https://github.com/DarthSim/overmind) or Foreman - `brew install tmux overmind` or `gem install foreman` - helps run all your processes in development
1525

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

0 commit comments

Comments
 (0)