{"id":17562067,"url":"https://github.com/kidd254/hello_rails_back_end","last_synced_at":"2025-03-29T11:42:22.242Z","repository":{"id":204879317,"uuid":"712863617","full_name":"Kidd254/Hello_Rails_Back_End","owner":"Kidd254","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-04T15:03:19.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-02-04T11:51:32.098Z","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/Kidd254.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}},"created_at":"2023-11-01T11:04:20.000Z","updated_at":"2023-11-01T11:22:28.000Z","dependencies_parsed_at":"2023-11-04T16:22:09.866Z","dependency_job_id":null,"html_url":"https://github.com/Kidd254/Hello_Rails_Back_End","commit_stats":null,"previous_names":["kidd254/hello_rails_back_end"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kidd254%2FHello_Rails_Back_End","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kidd254%2FHello_Rails_Back_End/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kidd254%2FHello_Rails_Back_End/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kidd254%2FHello_Rails_Back_End/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kidd254","download_url":"https://codeload.github.com/Kidd254/Hello_Rails_Back_End/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246180891,"owners_count":20736459,"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-21T12:25:21.511Z","updated_at":"2025-03-29T11:42:21.898Z","avatar_url":"https://github.com/Kidd254.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\u003cb\u003eHello Rails Backend\u003c/b\u003e\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📗 Table of Contents](#-table-of-contents)\n- [Hello API ](#hello-api-)\n  - [🛠 Built With ](#-built-with-)\n    - [Tech Stack ](#tech-stack-)\n    - [Key Features ](#key-features-)\n    - [Frontend Project  ](#frontend-project--)\n  - [💻 Getting Started ](#-getting-started-)\n    - [Prerequisites](#prerequisites)\n    - [Setup](#setup)\n    - [Install](#install)\n    - [Usage](#usage)\n    - [Run linters](#run-linters)\n  - [👥 Authors ](#-authors-)\n  - [🔭 Future Features ](#-future-features-)\n  - [🤝 Contributing ](#-contributing-)\n  - [⭐️ Show your support ](#️-show-your-support-)\n  - [🙏 Acknowledgments ](#-acknowledgments-)\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 simple API for displaying a random greeting, made with Ruby on Rails and Postgresql.\n\n---\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eBackend\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://guides.rubyonrails.org/\"\u003eRuby on Rails (v7.0.8)\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://www.postgresql.org/docs/\"\u003ePostgreSQL\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\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 framework\u003c/li\u003e\n  \u003cli\u003e\n    Use Linters to check code quality\n    \u003cul\u003e\n      \u003cli\u003eRubocop\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003eMVC architectural/design pattern\u003c/li\u003e\n  \u003cli\u003eData persistent in PostgreSQL\u003c/li\u003e\n  \u003cli\u003eRESTful API\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---\n\n### Frontend Project  \u003ca name=\"frontend-project\"\u003e\u003c/a\u003e\n\nThe frontend project for this API can be found in the following link: [Hello React Frontend](https://github.com/Kidd254/Hello_react_front_end)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\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\n\nIn order to run this project you need:\n\n\u003cul\u003e\n    \u003cli\u003e\u003cp\u003eA code editor (we recommend Visual Studio Code)\u003c/p\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cul\u003e\n    \u003cli\u003e\u003cp\u003eGit and a GitHub account\u003c/p\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n### Setup\n\nClone this repository to your desired folder by using this 👇️ command :\n\n```\ngit clone https://github.com/Kidd254/Hello_Rails_Back_End.git\n```\n\n### Install\n\nGo to the project directory:\n\n```\n cd hello_rails_back_end\n```\n\nBefore to run the program, verify that you have Ruby on Rails installed on your OS running the following command:\n\n```\n rails --version\n```\n\nIt should show you the version of ruby on rails ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby on Rails from scratch.\n\n[Download and Install Ruby on Rails](https://guides.rubyonrails.org/getting_started.html)\n\nOnce you have verified that you have Ruby on Rails installed, run the following command to install the necessary gems:\n\n```\n bundle install\n```\n\nAfter installing the gems, run the following command to create the database:\n\n```\n rails db:create\n```\n\nThen run the following command to migrate the database:\n\n```\n rails db:migrate\n```\n\n### Usage\n\nRun the following command inside the project folder to start the application:\n\n```\n  rails s\n```\n\nThose commands will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.\n\n### Run linters\n\nTo verify that the ruby code is written without errors and meets good practice standards, run the following command inside the project folder:\n\n- **ruby linter:**\n```\n rubocop\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👤 **Lawrence Muema Kioko**\n\n- GitHub: [@githubhandle](https://github.com/Kidd254)\n- Twitter: [@twitterhandle](https://twitter.com/lawrenc98789206)\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/lawrence-muema-kioko)\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- [ ] Add the endpoints to create, update and delete a greeting\n- [ ] Deploy the application\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/Kidd254/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** ⭐️ if you like this project!\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\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%2Fkidd254%2Fhello_rails_back_end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkidd254%2Fhello_rails_back_end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkidd254%2Fhello_rails_back_end/lists"}