Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluette1/vibes-api
https://github.com/bluette1/vibes-api
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bluette1/vibes-api
- Owner: Bluette1
- Created: 2024-09-23T22:32:43.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T09:15:07.000Z (about 1 month ago)
- Last Synced: 2024-11-21T09:33:16.578Z (about 1 month ago)
- Language: Ruby
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vibes API
Vibes API is a Ruby on Rails application designed to provide robust and secure data management for the Vibes app, featuring user management, secure data storage, and automated testing.
## Overview
- **User Management**: Admins can manage user roles and permissions.
- **Secure Data Storage**: All sensitive data is encrypted and securely stored.
- **Automated Testing**: CI/CD pipeline runs tests automatically on new commits.
## Getting Started
### Prerequisites
- Ruby 3.1
- Rails 7
- Bundler
- PostgreSQL
### Installation
1. **Clone the repository**:
```bash
git clone https://github.com/Bluette1/vibes-api.git
cd vibes-api
```
2. **Install dependencies**:
```bash
bundle install
```
3. **Set up the database**:
```bash
rake db:create db:migrate
```
4. **Run the application**:
```bash
rails server
```
### Running Tests
Execute the test suite using Rake:
```bash
bundle exec rake test
```
### Code Style
Ensure code style consistency with RuboCop:
```bash
bundle exec rubocop
```
## Contributing
1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Open a pull request.
**View user stories:** [https://www.notion.so/User-Stories-Vibes-11fe6a4d98f280c98b15d37c90890c0e?pvs=4](https://www.notion.so/User-Stories-Vibes-11fe6a4d98f280c98b15d37c90890c0e?pvs=21)
## License
This project is licensed under the MIT License.