{"id":20271614,"url":"https://github.com/progress2002/car-reservation-api","last_synced_at":"2025-04-11T04:30:13.110Z","repository":{"id":181013435,"uuid":"666064956","full_name":"Progress2002/car-reservation-api","owner":"Progress2002","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-31T17:30:05.000Z","size":118,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-05T02:10:49.920Z","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/Progress2002.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-07-13T16:16:41.000Z","updated_at":"2023-09-06T10:18:39.000Z","dependencies_parsed_at":"2024-11-14T12:43:48.418Z","dependency_job_id":null,"html_url":"https://github.com/Progress2002/car-reservation-api","commit_stats":null,"previous_names":["progress2002/car-reservation-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Progress2002%2Fcar-reservation-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Progress2002%2Fcar-reservation-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Progress2002%2Fcar-reservation-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Progress2002%2Fcar-reservation-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Progress2002","download_url":"https://codeload.github.com/Progress2002/car-reservation-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234105026,"owners_count":18780563,"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-11-14T12:38:49.883Z","updated_at":"2025-01-15T21:35:04.591Z","avatar_url":"https://github.com/Progress2002.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"### Table of Contents\n\n- [📖 carBooker](#car-booker)\n  - [🛠 Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n    - [Key Features](#key-features)\n    - [Kanban Board ](#-kanban-board-)\n    - [React Frontend ](#-react-frontend-)\n- [💻 Getting Started](#getting-started)\n  - [Setup](#setup)\n  - [Prerequisites](#prerequisites)\n  - [Install](#install)\n  - [Usage](#usage)\n  - [Run tests](#run-tests)\n  - [Deployment](#deployment)\n- [📝 API documentation](#api-documentation)\n- [👥 Authors](#authors)\n- [🔭 Future Features](#future-features)\n- [🤝 Contributing](#contributing)\n- [⭐️ Show your support](#support)\n- [🙏 Acknowledgements](#acknowledgements)\n- [📝 License](#license)\n\n## 📖 CarBooker \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\nCabooker (Backend) is a RESTful API for a car booking application. It allows users to book a car for a specific date and time. It also allows users to add and delete cars. The API is built with Ruby on Rails and uses Postgres as the database. It is consumed by its front-end counterpart [car-booker front-end](https://github.com/yodit93/car-reservation-front-end.git).\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\u003eRuby on Rails\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eDatabase\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003ePostgresql\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n### ERD Diagram \u003ca name=\"erd-diagram\"\u003e\u003c/a\u003e\n\n[ERD Diagram](https://lucid.app/lucidchart/3885e52f-ffbe-4394-a17c-22c1cd5f931a/edit?viewport_l[…]C909%2C0_0\u0026invitationId=inv_7ce0f69f-1908-44d7-9875-841ddbc89414)\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\nApi end points for users to:\n- Sign up\n- Sign in\n- Sign out\n- Add appointment for a Cars\n- Delete appointment for a Cars\n- Create and Delete Cars\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- KANBAN BOARD --\u003e\n\n## \u003cimg src=\"https://cdn-icons-png.flaticon.com/512/5360/5360804.png\" width=\"23\" height=\"20\"/\u003e Kanban Board \u003ca name=\"kanban-board\"\u003e\u003c/a\u003e\n\n- This project was built with a team of four.\n- Kanban Board Link [Kanban Board](https://github.com/users/yodit93/projects/7/views/1)\n- Initial state of the Kanban board [Kanban Board Screenshot](https://user-images.githubusercontent.com/53250640/253284640-fe30f83b-f7e1-4e34-ba79-e3127288e6dc.png)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- REACT FRONTEND --\u003e\n\n## \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/a/a7/React-icon.svg/539px-React-icon.svg.png\" width=\"23\" height=\"20\"/\u003e React Frontend \u003ca name=\"rails-backend\"\u003e\u003c/a\u003e\n\n- CarBooker frontend [CarBooker frontend](https://github.com/yodit93/car-reservation-front-end.git)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\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- Any web-browser.\n- Latest version of Ruby on Rails\n\n### Setup\n\nClone this [repo](https://github.com/Progress2002/car-reservation-api.git) to your desired folder.\n\n```\n    git clone https://github.com/Progress2002/car-reservation-api.git\n```\n\n### Install\n\nRun from a terminal\n\n```\n    cd car-reservation-api\n    bundle install\n```\n\n### Database\n**To connect the project to the database:-**\n```\n    rails db:create\n    rails db:migrate\n```\n\n### Usage\n\n**To run the project follow the following instruction:-**\n\n```\n    rails s -p 3001\n```\n\n### Run tests (using rspec)\n\nTo run the models test\n\n```\n  rspec ./spec/models\n```\n\nTo run the API Doc and endpoint test\n\n```\n  rails rswag:specs:swaggerize\n```\n\n### Deployment\n\nYou can deploy this project using: [render](https://render.com/).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## API Documentation\n\n**Once connected to the database, you can check the full API Documentation in here (please, double check the port):**\n\n```\n http://127.0.0.1:3001/api-docs/index.html\n\n```\n\n## Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Progress**\n\n- GitHub: [@Progress2002](https://github.com/Progress2002)\n- Twitter: [@Progress_2002](https://twitter.com/Progress_2002)\n- LinkedIn: [@Progress](https://www.linkedin.com/in/progress-ezeamaka-27b114247)\n\n👤 **Mugisha.I**\n\n- GitHub: [@githubhandle](https://github.com/Tafloninno)\n\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mugisha-innocent-19b700238/)\n\n\n👤 **Yodit Abebe**\n\n- GitHub: [yodit93](https://github.com/yodit93)\n- Twitter: [@yodtwit](https://twitter.com/yodtwit)\n- LinkedIn: [Yodit Abebe](https://www.linkedin.com/in/yodit-abebe-ayalew/)\n\n👤 **AdeJuwon DanieL Adesanya**\n\n- GitHub: [@githubhandle](https://github.com/Ade179)\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/adejuwon-adesanya-237b54239/)\n\n\n## Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n- **Add Admin role**\n- **Edit moto description**\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\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/Progress2002/car-reservation-api/issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## Support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project give us a ⭐️.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\nWe would like to thank Microverse for this project and [Murat Korkmaz on Behance](https://www.behance.net/muratk) for the original design idea.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\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=\"#table-of-contents\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogress2002%2Fcar-reservation-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogress2002%2Fcar-reservation-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogress2002%2Fcar-reservation-api/lists"}