{"id":17530950,"url":"https://github.com/ruthmy/hello-rails-back-end","last_synced_at":"2025-03-29T01:44:43.802Z","repository":{"id":206611736,"uuid":"710330465","full_name":"Ruthmy/hello-rails-back-end","owner":"Ruthmy","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-14T14:48:13.000Z","size":66,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-02-03T11:50:49.475Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ruthmy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-26T13:35:15.000Z","updated_at":"2023-11-17T23:22:14.000Z","dependencies_parsed_at":"2023-11-11T04:26:42.155Z","dependency_job_id":"3f3a2e84-d7b3-468d-a1e6-c66a2f5f176e","html_url":"https://github.com/Ruthmy/hello-rails-back-end","commit_stats":null,"previous_names":["ruthmy/hello-rails-back-end"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruthmy%2Fhello-rails-back-end","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruthmy%2Fhello-rails-back-end/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruthmy%2Fhello-rails-back-end/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ruthmy%2Fhello-rails-back-end/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ruthmy","download_url":"https://codeload.github.com/Ruthmy/hello-rails-back-end/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246126666,"owners_count":20727594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-20T17:06:02.306Z","updated_at":"2025-03-29T01:44:43.762Z","avatar_url":"https://github.com/Ruthmy.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003c!-- \u003cimg src=\"./app/assets/images/logo_white.png\" width=\"150px\"\u003e --\u003e\n  \u003ch1\u003e\u003cb\u003eHello Rails - Backend\u003c/b\u003e\u003c/h1\u003e\n\u003c/div\u003e\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📖 About the Project](#about-project)\n  - [🛠 Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n    - [Key Features](#key-features)\n    \u003c!-- - [🚀 Live Demo](#live-demo) --\u003e\n- [💻 Getting Started](#getting-started)\n  - [Setup](#setup)\n  - [Prerequisites](#prerequisites)\n  - [Install](#install)\n  - [Usage](#usage)\n  - [Run tests](#run-tests)\n  - [Deployment](#triangular_flag_on_post-deployment)\n- [👥 Authors](#authors)\n- [🔭 Future Features](#future-features)\n- [🤝 Contributing](#contributing)\n- [⭐️ Show your support](#support)\n- [🙏 Acknowledgements](#acknowledgements)\n- [📝 License](#license)\n\n---\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n#  Hello Rails - Backend \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n**\"Hello Rails - Backend\"** is a small project to practice the basics of Ruby on Rails as an API to be consumed by a React/Redux Toolkit application.\n\nTwo repositories were created for its construction:\n- [A backend repository](https://github.com/Ruthmy/hello-rails-back-end) with an API built with the [Ruby on Rails](https://rubyonrails.org/) Framework with a [PostgreSQL](https://www.postgresql.org/) database.\n- [A frontend repository](https://github.com/Ruthmy/hello-react-front-end) with a React/Redux Toolkit application from which the created API is consumed.\n\n\n---\n\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n### Tech Stack\n\nThe project is built using the following technologies:\n\n* Ruby on Rails.\n* PostgreSQL.\n* Rubocop.\n\n\u003cbr\u003e\n\n---\n\n\u003c!-- Features --\u003e\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n\u003cul\u003e\n  \u003cli\u003eRuby on Rails\u003c/li\u003e\n  \u003cli\u003eLinters\n    \u003cul\u003e\n      \u003cli\u003eRubocop\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003eFollow Microverse's list of best practices\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ---\n\n\n## 🚀 Live Demo \u003ca name=\"live-demo\"\u003e\u003c/a\u003e\n\n- 🎤 [Project presentation: video demo](https://www.loom.com/share/a57b45a0708545d9bac18071ead813e2?sid=bbd6e390-585b-487b-8157-76dc5cb071ee)\n- [Live Demo Link](https://budget-app-st58.onrender.com)\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e --\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\nTo get a local copy up and running, follow these steps.\n\n### Prerequisites\nIn order to run this project you need to have:\n\n- Installed Ruby and Ruby on Rails.\n- If you're using Windows, have installed WSL.\n- If you're using MacOS, an option is using UTM.\n\n### Setup\nTo clone this repository to your desired folder, run the following command: \u003cbr\u003e\n\n```\ngit clone https://github.com/Ruthmy/hello-rails-back-end\n```\n\nNavigate to the cloned repository and run the following command to install the necessary gems:\n```\ncd hello-rails-back-end\nbundle install\n```\nBefore continue you will need to create your own credentials file. To do so, first remove config/master.key and config/credentials.yml.enc if they exist.\n\nrun the following command:\n```\nEDITOR=code rails credentials:edit \n```\nYou can close the editor that opens. This command will create a new master.key and credentials.yml.enc if they do not exist. Now you can continue.\n\n## Usage\nInitialize it with\n```\nrails server\n```\nThen open `http://localhost:4000` in your browser.\n\nNow you need to create the database, run the following command:\n```\nrails db:create\n```\nThen migrate the database:\n```\nrails db:migrate\n```\nAnd finally, seed the database:\n```\nrails db:seed\n```\n\n### Test\nTo run the tests try the following command:\n```\nrspec spec\n```\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- AUTHORS --\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n\n👤 **Ruth Abreu**\n\n- GitHub: [@Ruthmy](https://github.com/Ruthmy)\n- Twitter: [@rury_exe](https://twitter.com/rury_exe)\n- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\nUpcoming improvements:\n\n- [ ] Accessibility improvements.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 🤝 Contributing \u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\nContributions, issues, and feature requests are welcome!\n\nFeel free to check the [issues page](https://github.com/Ruthmy/hello-rails-back-end/issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- SUPPORT --\u003e\n\n## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project and know someone who might find it helpful, please share it.\nOr give it a **star** ⭐️\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\nI thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---\n\n\u003c!-- LICENSE --\u003e\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is [MIT](./LICENSE) licensed.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n---","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruthmy%2Fhello-rails-back-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruthmy%2Fhello-rails-back-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruthmy%2Fhello-rails-back-end/lists"}