Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitor0p9f/ruby-substrings
Project suggested by The Odin Project platform: https://www.theodinproject.com/lessons/ruby-sub-strings
https://github.com/vitor0p9f/ruby-substrings
rspec ruby string substring
Last synced: 18 days ago
JSON representation
Project suggested by The Odin Project platform: https://www.theodinproject.com/lessons/ruby-sub-strings
- Host: GitHub
- URL: https://github.com/vitor0p9f/ruby-substrings
- Owner: vitor0p9f
- Archived: true
- Created: 2023-12-20T17:14:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-19T20:52:18.000Z (about 1 year ago)
- Last Synced: 2024-09-26T18:28:05.291Z (4 months ago)
- Topics: rspec, ruby, string, substring
- Language: Ruby
- Homepage:
- Size: 398 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
Awesome Lists containing this project
README
This README is available in the following languages:
# Study Repository - Ruby substrings
This project was developed for the practice of basic concepts of the Ruby language and other tools and design patterns.
## :movie_camera: Project demonstration
https://github.com/vitor0p9f/ruby-substrings/assets/153991573/3f92eeee-1973-4bb0-8525-d4a30f36ca45
## :gem: Used Gems
* Rspec
## :page_facing_up: Used Design Patterns
* TDD (_Test Driven Development_)
* Conventional commits
## :pushpin: Acquired Knowledge
* How to apply TDD to projects.
* How to use Docker to create application containers.
* Writing better commit messages with conventional commit standards.
* Basic string manipulation methods in Ruby.
* Input and output of information in Ruby.
## :triangular_flag_on_post: Challenges Encountered
* During development, it was observed that the special character '\n', present at the end of a string when enter is pressed in the terminal, was impacting the code's functionality.
## :rocket: Running the Project
### 1. Clone the repository to your machine
Once the repository is on your machine, enter the newly cloned directory.
To run this project on your own machine, you can choose between the options:
* Run the project using Docker.
* Run the project by installing the dependencies.
### :whale2: Using Docker
#### :construction: Requirements
* Have Docker installed and configured on your machine.
#### 2. Build a project image using the following command:
```bash
docker build -t ruby-substrings .
```
The created image will have the same name as the project.
#### 3. Create a container based on the newly created image using the command:
```bash
docker run -it --name ruby-substrings ruby-substrings
```
The above command will use the previously created image to create a container with the project name.
After running the above command, the container's terminal should automatically open, already executing the project code.
To run the project again without creating a new container, simply run the following command:
```bash
docker start -i ruby-substrings
```
### :link: Installing Dependencies
#### :construction: Requirements
* Have Ruby installed on your machine.
* I recommend using tools like RVM or rbenv to allow the installation of Gems without administrator permission.
#### 2. Install project dependencies by running the command:
```bash
bundle install
```
#### 3. Run the project by executing the command:
```bash
ruby substrings.rb
```