{"id":19048174,"url":"https://github.com/graujavier/final-capstone-back-end","last_synced_at":"2025-04-24T00:50:25.691Z","repository":{"id":203774352,"uuid":"709793397","full_name":"grauJavier/final-capstone-back-end","owner":"grauJavier","description":"RentEaze is a rental booking app that allows users to easily reserve visits of places for rent. Browse available listings, view details, check calendars and instantly book visits. Property owners can also publish and manage their rental listings, set rates and availability, and approve booking requests all through the intuitive app interface.","archived":false,"fork":false,"pushed_at":"2023-11-16T16:32:24.000Z","size":306,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-03-30T05:23:08.318Z","etag":null,"topics":["ror-api","ruby-on-rails"],"latest_commit_sha":null,"homepage":"https://renteaze-d1cc8b293660.herokuapp.com/api-docs/index.html","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/grauJavier.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-25T12:13:00.000Z","updated_at":"2023-11-20T20:04:32.000Z","dependencies_parsed_at":"2025-01-18T15:58:00.173Z","dependency_job_id":"d4eb8e1c-7ea1-411d-a479-3ebdb5572eca","html_url":"https://github.com/grauJavier/final-capstone-back-end","commit_stats":null,"previous_names":["graujavier/final-capstone-back-end"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grauJavier%2Ffinal-capstone-back-end","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grauJavier%2Ffinal-capstone-back-end/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grauJavier%2Ffinal-capstone-back-end/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grauJavier%2Ffinal-capstone-back-end/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grauJavier","download_url":"https://codeload.github.com/grauJavier/final-capstone-back-end/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250540956,"owners_count":21447426,"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":["ror-api","ruby-on-rails"],"created_at":"2024-11-08T23:05:33.110Z","updated_at":"2025-04-24T00:50:25.667Z","avatar_url":"https://github.com/grauJavier.png","language":"Ruby","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n  \u003ch3\u003e\u003cb\u003eFinal Capstone Back End\u003c/b\u003e\u003c/h3\u003e\n\n\u003c/div\u003e\n\n# 📗 Table of Contents\n\n- [📗 Table of Contents](#-table-of-contents)\n- [📖 final\\_capstone\\_back\\_end ](#-final_capstone_back_end-)\n  - [🛠 ER Diagram ](#-er-diagram-)\n  - [💻 link to front end ](#-link-to-front-end-)\n  - [💻 link to Kanban board information ](#-link-to-kanban-board-information-)\n  - [🛠 Built With ](#-built-with-)\n    - [Tech Stack ](#tech-stack-)\n    - [Key Features ](#key-features-)\n  - [💻 Getting Started ](#-getting-started-)\n    - [Prerequisites](#prerequisites)\n    - [Setup](#setup)\n    - [Install](#install)\n    - [Database Setup](#database-setup)\n    - [Usage](#usage)\n  - [🔬 Running Tests ](#-running-tests-)\n    - [Test Suite](#test-suite)\n  - [💻 API Documentation ](#-api-documentation-)\n  - [👥 Authors ](#-authors-)\n  - [🔭 Future Features ](#-future-features-)\n  - [🤝 Contributing ](#-contributing-)\n  - [⭐️ Show your support ](#️-show-your-support-)\n  - [🙏 Acknowledgments ](#-acknowledgments-)\n  - [❓ FAQ (OPTIONAL) ](#-faq-optional-)\n  - [📝 License ](#-license-)\n\n\n# 📖 Final Capstone Back End \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n**final_capstone_back_end** The back-end component of this final capstone project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate creation of places to rent, and to allow users to make reservations for those places. It leverages a PostgreSQL database to manage and store reservation data. The API is designed to be consumed by a front-end application, which is developed using React.js.\n\n## 🛠 ER Diagram \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n![ER Diagram](./src/ERD.png)\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 💻 Link to front end \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n\n[Link to Front End](https://github.com/grauJavier/final-capstone-front-end)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 💻 link to Kanban board information \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n[Link to Kanban Board](https://github.com/grauJavier/final-capstone-back-end/projects/1)\n\n[Initial state](https://github.com/grauJavier/final-capstone-front-end/issues/38)\n\nThis project was completed by three Team members:\n\n- Javier Grau\n- Manuel Sanchez\n- Anthony Vásquez\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\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\u003eTechnologies\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://rubyonrails.org/\"\u003eRuby on Rails\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003eLinters\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003eRubocop\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n- **Ruby on Rails**\n- **API Endpoint**\n- **Professional Documentation**\n- **Linting for Code Quality**\n- **Postgres Database**\n- **Git Version Control**\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\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\nBefore you begin, ensure you have the following prerequisites installed on your system:\n\n- Ruby: You need Ruby to run the Ruby on Rails application.\n- Bundler: Bundler is used to manage gem dependencies for your Ruby project.\n\n### Setup\n\nIn your terminal, navigate to the folder of your choice and clone the repository with the following commands:\n\n```sh\ncd my-folder\ngit clone git@github.com:grauJavier/final-capstone-back-end.git\n\n```\n\n### Install\n\nAfter cloning the project, change into the project directory:\n\n```sh\ncd final_capstone_back_end\n\n```\n\nInstall this project with:\n\n- gem install rails\n- bundle install\n\n### Credentials setup\nIn order to create databases and run the tests, you need to follow this steps:\n1. Remove config/master.key and config/credentials.yml.enc if they exist.\n2. Run `rails secret`. This will generate a key. Copy and reserve the key to use later.\n3. If you use Windows run: `$env:EDITOR=\"code --wait\"; rails credentials:edit` If you use Linux run: `EDITOR=\"code --wait\" bin/rails credentials:edit`\n4. Your editor will open a file, add at the bottom `devise_jwt_secret_key: \u003cthe key you copied in step 2\u003e`\n5. Save the file and close the editor.  New master.key, credentials.yml.enc files will be generated, and the key will be stored in `Rails.application.credentials.devise_jwt_secret_key`.\n\n### Database Setup\n\nCreate and migrate your database with:\n\n```sh\n\nrails db:create\nrails db:migrate\nrails db:seed\n\n```\n### Usage\n\nTo run the project, execute the following command:\n\n```sh\n\nrails server\nor\nrails s\n\n```\nThis should start your local server on http://localhost:3000/. Now, you can use the REST API client of your choice to interact with the API.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## 🔬 Running Tests \u003ca name=\"running-tests\"\u003e\u003c/a\u003e\n\nTo run tests, navigate to the directory where the project is located on your machine, open your terminal, and follow these steps:\n\n### Test Suite\n\nThis project contains a suite of unit tests which you can run to ensure everything is functioning as expected. To run these tests, you need RSpec installed.\n\nTo install RSpec if you haven't already, run:\n\n```sh\ngem install rspec\n\n```\n\nAfter you've installed RSpec, you can run the tests with:\n\n```sh\n\nrspec\n\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 💻 API Documentation \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[API Documentation](https://renteaze-d1cc8b293660.herokuapp.com/api-docs/index.html)\n\n\n![API Methods](./src/API_documentation.png)\n\n\u003c/div\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Javier Grau**\n\n- GitHub: [@grauJavier](https://github.com/grauJavier)\n- LinkedIn: [Javier Grau](https://www.linkedin.com/in/javiergrau)\n\n👤 **Manuel Sanchez**\n\n- GitHub: [@Luffytaro22](https://github.com/Luffytaro22)\n- LinkedIn: [Manuel Sanchez](https://www.linkedin.com/in/manuel-alejandro-sanchez-sierra/)\n\n👤 **lRebornsl**\n\n- GitHub: [@lRebornsl](https://github.com/lRebornsl)\n- Twitter: [@RebornsDev](https://twitter.com/RebornsDev)\n- LinkedIn: [Anthony Vásquez](https://www.linkedin.com/in/avvm98/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n- [ ] **Implement proper user authentication from the front-end to the server**\n- [ ] **Add authorizations to users**\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\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/grauJavier/final-capstone-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## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project please feel free to send me corrections for make it better I would feel glad to read your comments.\nAnd think If you enjoy gift me a star.  \n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\n- Behance and Murat Korkmaz for the [original design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)\n- Microverse for providing the opportunity to learn in a collaborative environment.\n- React.js Documentation for valuable resources on React development.\n- GitHub for version control and collaboration tools.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## ❓ FAQ (OPTIONAL) \u003ca name=\"faq\"\u003e\u003c/a\u003e\n\n- **Can I use with a templeate your project?**\n\n  - Of course we would feel honored.\n\n- **Your project is free license?**\n\n  - Yeah, you can use it completely.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is licensed under the MIT License - you can click here to have more details [MIT](./LICENSE).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraujavier%2Ffinal-capstone-back-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraujavier%2Ffinal-capstone-back-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraujavier%2Ffinal-capstone-back-end/lists"}