https://github.com/andercm/mr_peanutbutter
https://github.com/andercm/mr_peanutbutter
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andercm/mr_peanutbutter
- Owner: anderCM
- Created: 2025-02-15T18:52:39.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2025-02-15T19:45:17.000Z (over 1 year ago)
- Last Synced: 2025-02-15T20:29:32.664Z (over 1 year ago)
- Language: Ruby
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mr Peanutbutter API
A RESTful API developed with Ruby on Rails, providing crypto services using the [CoinGecko API](https://docs.coingecko.com/reference/introduction). This project uses Docker for easier development and deployment.
---
## Content
- [Mr Peanutbutter API](#mr-peanutbutter-api)
- [Content](#content)
- [Description](#description)
- [Características](#características)
- [Technologies](#technologies)
- [Installation](#installation)
- [Previous Requirements](#previous-requirements)
- [Steps to Configure this Repo Locally](#steps-to-configure-this-repo-locally)
---
## Description
**Mr Peanutbutter API** is a project developed with Ruby on Rails that offers endpoints to consult cryptocurrency prices and register transactions for buying/selling. This application uses Docker to create a more robust environment and to simplify development.
---
## Características
- **API RESTful:** Built following the best practices of Ruby on Rails.
- **Documentation:** Uses Swagger to display API documentation.
- **Tests:** Integrated with RSpec to ensure code quality.
---
## Technologies
- **Backend:** Ruby (3.2) and Ruby on Rails (7.2.2)
- **Containers:** Docker & Docker Compose
- **Documentation:** Swagger (rswag-api, rswag-ui, rswag-specs)
- **Tests:** RSpec
- **Database:** PostgreSQL
---
## Installation
### Previous Requirements
- [Docker](https://www.docker.com/get-started)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [VS Code](https://code.visualstudio.com/) or any other IDE
### Steps to Configure this Repo Locally
1. **Clone the repository:**
```bash
git clone https://github.com/anderCM/mr_peanutbutter.git
cd mr_peanutbutter
2. Set up your own `.env` file or use `.env.example`
3. Run:
```
docker-compose build
docker-compose up -d
4. Install necessary gems using one of these options:
- **4.1** From your local environment: `docker-compose run api bundle install`
- **4.2** By connecting to the container:
```
docker-compose exec api bash
bundle install
5. Create the DB using one of these options:
- **4.1** From your local environment: `docker-compose run api rails db:create`
- **4.2** By connecting to the container:
```
docker-compose exec api bash
rails db:create
6. Visit http://localhost:3000 or use any PORT you configured in `.env` file