https://github.com/alybadawy/auth-horus
An Authorization framework for Rails 8+ API-only applications
https://github.com/alybadawy/auth-horus
api api-only authentication jwt rails rails8 ruby-on-rails
Last synced: about 2 months ago
JSON representation
An Authorization framework for Rails 8+ API-only applications
- Host: GitHub
- URL: https://github.com/alybadawy/auth-horus
- Owner: AlyBadawy
- License: gpl-2.0
- Created: 2025-02-11T16:21:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T20:48:32.000Z (about 1 year ago)
- Last Synced: 2025-04-11T04:39:36.913Z (about 1 year ago)
- Topics: api, api-only, authentication, jwt, rails, rails8, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 188 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Auth Horus
A secure authentication system built with Ruby on Rails, featuring comprehensive testing and robust security measures.
## 🚀 Quick Start
### Prerequisites
- Ruby (per `.ruby-version`)
- PostgreSQL
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/alybadawy/auth-horus.git
cd auth-horus
```
2. **Install dependencies**
```bash
bundle install
```
3. **Set up database**
```bash
bundle exec rails db:create
bundle exec rails db:schema:load
```
## 🔧 Development
Start the development server:
```bash
bin/dev
```
## 🧪 Testing
Run the test suite:
```bash
bundle exec rspec
```
> 📊 Minimum test coverage requirement: 95%
## 🛡️ Quality Assurance
### Code Style
```bash
bin/rubocop
```
### Security Scan
```bash
bin/brakeman
```
## 🔄 CI/CD
Our GitHub Actions workflow automatically runs:
- Security vulnerability scans
- Code style checks
- Test suite
- Coverage reports
## 🗄️ Database Configuration
PostgreSQL environment variables:
```bash
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=test_db
```
## 🔑 Key Features
- Secure authentication system
- Comprehensive test coverage
- Static code analysis
- Security vulnerability scanning
- Automated CI/CD pipeline
## 📝 License
Licensed under the GNU General Public License v2.0. See [LICENSE](LICENSE) for details.
## 🤝 Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
---
Made with ❤️ using Ruby on Rails
Developed by Aly Badawy
