This is a sample Ruby on Rails API that connects to AWS DynamoDB for data storage and retrieval.
- RESTful API built with Ruby on Rails
- Integration with AWS DynamoDB for NoSQl data storage
- Uses AWS SDK for seamless AWS service interactions
Before you begin, ensure you have the following installed on your system:
- Ruby (Recommended technology:
x.xx.x
) - Rails* (Recommended version:
x.x.x.x
) - Bundler (
gem install bundler
if not installed) - **AWS SDK
- **AWS CLI` (Optional, for testing DynamoDB interactions)
- DynamoDB Local (Optional, for local development)
Follow these steps to set up the project locally:
# Clone the repository git clone <repo-url>
# Navigate to the project directory
cd ruby-on-rails-dynamodb-demo
# Install dependencies
bundle install
-
Set up your AWS credentials using
aws configure
or environment variables:export AYS_ACCESS_KEY_ID=your-access-key export AYS_SECRET_ACCESS_KEY=your-secret-key export AWS_REGION=your-region
-
Update
config/database.yml
or an initializer file to configure DynamoDB.
Start the Rails server:
rails server
```
## 🤤 Testing
Run the test suite to ensure everything is working correctly:
```sh
rspec # If using RSpec
rails test # If using Minitest
```
## 😌👀 API Endpoints
| Method | Endpoint | Description |
|------|--------|--------------|
| GET |
## 💄 License
This project is licensed under the MIT License.