https://github.com/peimelo/blog_api
Ruby on Rails 6 course as API showing authentication via devise_token_auth.
https://github.com/peimelo/blog_api
api course devise devise-token-auth rspec ruby-on-rails video-course
Last synced: about 2 months ago
JSON representation
Ruby on Rails 6 course as API showing authentication via devise_token_auth.
- Host: GitHub
- URL: https://github.com/peimelo/blog_api
- Owner: peimelo
- Created: 2021-03-10T09:02:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-17T11:15:09.000Z (over 2 years ago)
- Last Synced: 2025-03-24T22:32:11.680Z (2 months ago)
- Topics: api, course, devise, devise-token-auth, rspec, ruby-on-rails, video-course
- Language: Ruby
- Homepage: https://course-blog-api.fly.dev
- Size: 157 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blog API
Ruby on Rails 6 course as API showing authentication via [devise_token_auth](https://github.com/lynndylanhurley/devise_token_auth).
This repository is part of the [Ruby on Rails 6 - Autenticação via API](https://www.youtube.com/watch?v=i6vul6MqylE&list=PLqsayW8DhUmsuvK17gwSI_rKbAlmxFIw5) on YouTube.
Ruby version
3.0.3
Rails version
6.1.5
Database
PostgreSQL
## Configuration
```bash
git clone https://github.com/peimelo/blog_api.git
cd blog_api
# installation of dependencies
bundle install
# creation of database and tables
rails db:create
rails db:migrate
rails db:migrate RAILS_ENV=test
# run the project
rails s
```
The backend is available at `http://localhost:3000`.
## Configuration for Production
```bash
# delete the config/credentials.yml.enc file
rm config/credentials.yml.enc
# run the command to create credentials and master key (replace 'code' if you don't use VS Code)
EDITOR="code --wait" bin/rails credentials:edit
```
Add the information below in the [credentials](https://guides.rubyonrails.org/security.html#custom-credentials) to configure the email used by the Devise
gem (replace with the values you want):
```yml
# ... your content above
gmail:
user_name: [email protected]
password: your_password
exception_recipients: [email protected]
```
Save and close the `config/credentials.yml.enc` file.
If you want to use another email provider, change it in the file
`config/environments/production.rb`.
To configure `default_confirm_success_url`, change it in the file
`config/initializers/devise_token_auth.rb`.
To configure [CORS](https://github.com/cyu/rack-cors) `origins`, change it in the file
`config/initializers/cors.rb`.
To configure [Exception Notification](https://github.com/smartinez87/exception_notification), change it in the file
`config/initializers/exception_notification.rb`.
## Tests
To run the tests:
```bash
bundle exec rspec
```
### Using Insomnia to test the API
If you want to import the requests into [Insomnia](https://insomnia.rest/download), use the file `Insomnia.json` at the root of this project.
It will be necessary to install the plugin [insomnia-plugin-dotenv](https://insomnia.rest/plugins/insomnia-plugin-dotenv).
Create an environment variable file at the root of the project to add sensitive data:
```bash
touch .env.development
```
Add the contents below to the file above:
```bash
password=your-password
access-token=your-access-token
client=your-client
```
In Insomnia, go to `Manage Environments` and set the `envFilePath` value to the file path `.env.development`:
```json
{
// ... your code above
"envFilePath": "/path/to/file/your_repo/.env.development"
}
```
Any `.env.*` file is being ignored by this project's GIT.