https://github.com/madcato/railsserver
Boilerplate rails project
https://github.com/madcato/railsserver
boileplate rails rails5 rvm
Last synced: 2 months ago
JSON representation
Boilerplate rails project
- Host: GitHub
- URL: https://github.com/madcato/railsserver
- Owner: madcato
- Created: 2018-06-09T11:30:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-09T01:32:11.000Z (over 3 years ago)
- Last Synced: 2023-08-23T22:16:57.195Z (almost 3 years ago)
- Topics: boileplate, rails, rails5, rvm
- Language: Ruby
- Size: 139 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RailsServer
Generic boilerplate server made in RubyOnRails to start new projects.
## Install
1. Install rvm from: [Installing RVM](https://rvm.io/rvm/install)
2. Install Ruby with rvm
$ rvm install "ruby-2.6.6"
3. Install Rails 5.2.4.4
4. Git clone this project
5. Isntall bundle
$ gem install bundle
6. Enter in project dir an update gems with:
$ bundle update
7. Install libv8
On macOS:
brew install v8
On Linux
sudo apt-get install libv8-dev
8. Migrate db
$ rake db:migrate
9. Seed database
$ rake db:seed
This will create and admin user (dani\_vela@me.com , password: 123456)
10. Run the server
$ bundle exec rails server
11. Open a browser and open `http://localhost:3000/admin` url.
12. To see swagger doc open `http://localhost:3000/api-docs/index.html` url
## Testing
Launch tests with command:
$ rails t
## This project contains
- [Devise (for user authentication and registering)](https://github.com/plataformatec/devise)
- [simple\_token\_authentication (for token authentication)](https://github.com/gonzalo-bulnes/simple_token_authentication)
- [rails\_admin (db administration)](https://github.com/sferik/rails_admin)
- [cancancan (authorization management)](https://github.com/CanCanCommunity/cancancan)
- [Swagger api, ui and specs](https://github.com/rswag/rswag)
## ActiveStoreage (Rails 5.0) for file upload
Use the model **Airline** as a sample for uploading files
- [ActiveStorage documentation](https://edgeguides.rubyonrails.org/active_storage_overview.html)
## New users
Create new user with [http://localhost:3000/users/sign_up](http://localhost:3000/users/sign_up)
## Instructions to change the name of the project
Change all occurrences of "RailsServer" string to your project name
This string appears in this files:
- app/views/layouts/application.html.erb
- config/appication.rb
- config/initializers/session\_store.rb
## Gems
- https://github.com/hothero/awesome-rails-gem
- https://dev.to/rob__race/27-gems-i-use-in-almost-every-project