Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/israeldcastro/rails-api-template
Create a Rails API app using VueJS/ReactJS as front, it is good to start a project. You can choose between Tailwind CSS + PrimeVue or Tailwind CSS + NextUI.
https://github.com/israeldcastro/rails-api-template
nextui primevue rails rails-api react reactjs ruby starter-template tailwindcss template vite vitejs vue vuejs
Last synced: about 8 hours ago
JSON representation
Create a Rails API app using VueJS/ReactJS as front, it is good to start a project. You can choose between Tailwind CSS + PrimeVue or Tailwind CSS + NextUI.
- Host: GitHub
- URL: https://github.com/israeldcastro/rails-api-template
- Owner: IsraelDCastro
- Created: 2024-05-13T19:16:26.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-05-16T20:35:49.000Z (4 months ago)
- Last Synced: 2024-09-26T15:01:05.245Z (about 8 hours ago)
- Topics: nextui, primevue, rails, rails-api, react, reactjs, ruby, starter-template, tailwindcss, template, vite, vitejs, vue, vuejs
- Language: Ruby
- Homepage:
- Size: 90.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Rails API Template VueJS/ReactJS
This is a rails template with VueJS or ReactJS. Also you can choose between CSS Frameworks as: Tailwind CSS, PrimeVue (For VueJS), or NextUI (For ReactJS).
This is the best option to start a project with Rails 7 API + VueJS/ReactJS. You can make a fast project and start working on it without any problem. Now you can choose between Tailwind CSS and PrimeVue (For VueJS) or Tailwind CSS and NextUI (For ReactJS).
This template starts with Active Storage by default when you create it. If you don't want, just remove it.
### JS Frameworks
- `VueJS 3` to start a project with VueJS just add the flag `--vue` to command line.
- `ReactJS 18` to start a project with ReactJS just add the flag `--react` to command line.
### CSS Frameworks
- `template.rb` has Tailwind CSS as default Framework CSS. [Start](https://github.com/IsraelDCastro/rails-vite-tailwindcss-template#rails-tailwind-css-template)
## Installation
Make sure you have `vips` in your brew list, or run `brew install vips`
## Rails 7 + VueJS 3 + ViteJS + Tailwind CSS + PrimeVue
##### From GitHub with vue
```bash
rails new my_app --api -d -m https://raw.githubusercontent.com/IsraelDCastro/rails-api-template/master/template.rb --vue
```
##### Making a git clone of the project with vue
```bash
rails new my_app --api -d -m template.rb --vue
```
When you clone the repo just be sure to be inside the project when you run the command, from outside be sure to put the correct file direction `./template-api/template.rb`.
## Rails 7 + ReactJS 18 + ViteJS + Tailwind CSS + NextUI
##### From GitHub with react
```bash
rails new my_app --api -d -m https://raw.githubusercontent.com/IsraelDCastro/rails-api-template/master/template.rb --react
```
##### Making a git clone of the project with react
```bash
rails new my_app --api -d -m template.rb --react
```
When you clone the repo just be sure to be inside the project when you run the command, from outside be sure to put the correct file direction `./template-api/template.rb`.
### Default Vue/React dependencies
> - primevue (Only with flag `--vue`)
> - vue (Only with flag `--vue`)
> - vue-router (Only with flag `--vue`)
> ---
> - react (Only with flag `--react`)
> - react-dom (Only with flag `--react`)
---
### Default VueJS dev dependencies
> - @vitejs/plugin-vue
> - autoprefixer
> - eslint
> - eslint-config-prettier
> - eslint-plugin-prettier
> - eslint-plugin-vue
> - path
> - postcss
> - prettier
> - tailwindcss
> - vite
### Default ReactJS dev dependencies
> - eslint
> - eslint-plugin-tailwindcss (Only the template with Tailwind CSS has this package).
> - eslint-plugin-vue (Only with flag `--vue`)
> - path
> - prettier
> - eslint-plugin-prettier
> - eslint-config-prettier
> - vite
> - autoprefixer
> - postcss
> - tailwindcss
> - @vitejs/plugin-react-refresh (Only with flag `--react`)
> - eslint-plugin-react (Only with flag `--react`)
### Default gems
> - gem "image_processing", "~> 1.2"
> - gem 'ruby-vips', '~> 2.1', '>= 2.1.4'
> - gem "rack-cors"
> - gem 'jwt'
> - gem 'bcrypt', '~> 3.1.18'
> - gem "annotate", group: :development
> - gem 'solargraph', group: :development
### Thank you ⭐️
If you have any questions, just make an issue, I'll answer you as soon as possible.