{"id":17565561,"url":"https://github.com/alierpm/hello-rails-back-end","last_synced_at":"2025-03-29T12:45:47.035Z","repository":{"id":225340373,"uuid":"764893063","full_name":"AlierPM/hello-rails-back-end","owner":"AlierPM","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-01T15:42:52.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-02-04T13:44:13.803Z","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/AlierPM.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":"2024-02-28T22:37:52.000Z","updated_at":"2024-02-28T22:46:09.000Z","dependencies_parsed_at":"2024-12-09T18:12:26.390Z","dependency_job_id":null,"html_url":"https://github.com/AlierPM/hello-rails-back-end","commit_stats":null,"previous_names":["alierpm/hello-rails-back-end"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlierPM%2Fhello-rails-back-end","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlierPM%2Fhello-rails-back-end/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlierPM%2Fhello-rails-back-end/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlierPM%2Fhello-rails-back-end/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlierPM","download_url":"https://codeload.github.com/AlierPM/hello-rails-back-end/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246187220,"owners_count":20737460,"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-21T14:26:27.331Z","updated_at":"2025-03-29T12:45:47.020Z","avatar_url":"https://github.com/AlierPM.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"#  Table of Contents\n\n- [ About Hello-Rails-Back-End](#about-hello-rails-back-end)\n  - [ Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n    - [Key Features](#key-features)\n  - [ Getting Started](#getting-started)\n    - [Setup](#setup)\n    - [Prerequisites](#prerequisites)\n    - [Install](#install)\n    - [Usage](#usage)\n    - [Run Project](#run-project)\n    - [Run Tests](#run-tests)\n  - [ Contributors](#contributors)\n  - [ Future features?](#future-features)\n  - [ Let's Collaborate](#lets-collaborate)\n  - [⭐️ Star It](#star-it)\n  - [ Acknowledgments](#acknowledgements)\n  - [❓ FAQ](#faq)\n  - [ License](#license)\n\n\u003ca name=\"about-hello-rails-back-end\"\u003e\u003c/a\u003e\n\n##  About Hello-Rails-Back-End\n\nThis project serves as the back-end API for a simple \"Hello world\" application, providing functionality for fetching and displaying random greetings.\n\n\u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n##  Built With\n\n### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n\n- Ruby (version 2.6 or later)\n- Rails (version 6.1.5 or later)\n- Postgres (database, configured using `config/database.yml`)\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n- Generates and stores unique greetings using a `Message` model.\n- Provides a REST API endpoint `/greetings/random` that returns a random greeting in JSON format.\n\n\u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\n##  Getting Started\n\n\u003e The following steps will guide you in setting up and running Hello-Rails-Back-End:\n\n### Prerequisites \u003ca name=\"prerequisites\"\u003e\u003c/a\u003e\n\n- Ensure Ruby and Rails are installed (check versions with `ruby -v` and `rails -v`). Refer to https://guides.rubyonrails.org/ for installation instructions if needed.\n- Node.js and npm are required for development purposes (check versions with `node -v` and `npm -v`). Install them from https://nodejs.org/en if not present.\n\n### Install \u003ca name=\"install\"\u003e\u003c/a\u003e\n\n1. Clone the project:\n   ```bash\n   git clone https://your-github-username/hello-rails-back-end.git\n   ```\n\n2. Navigate to the project directory:\n   ```bash\n   cd hello-rails-back-end\n   ```\n3. Configure database connection (Postgres):\n\n   - Edit the config/database.yml file with  your Postgres credentials.\n   - Alternatively, use a database service like Heroku or AWS RDS.\n\n4. Seed the database with sample data:\n   ```bash\n   rails db:seed\n   ```\n   to populate the database with sample greetings.\n\n5. Run migrations if needed:\n   ```bash\n   rails db:migrate\n   ```\n\n\n### Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e\n\n- The project is ready to use as a back-end API for a front-end application.\n- The API endpoint `/greetings/random` returns a random greeting in JSON format.\n\n- The application is designed to be used in conjunction with the React front-end. To run the front-end, please refer to the [Hello-React-Front-End](https://github.com/AlierPM/hello-react-front-end) repository.\n  \n    ```bash\n    {\n    \"content\": \"Hello, world!\"\n    }\n    ```\n- The API can be tested using a tool like Postman or cURL.\n\n### Run Project \u003ca name=\"run-project\"\u003e\u003c/a\u003e\n\n1. Start the development server::\n    ```bash\n    rails s\n    ```\n\n2. Access the API endpoint at:\n   ```bash\n    `http://localhost:3000` by default.\n\n    http://localhost:3000/greetings/random (or the port specified by rails server)\n    ```\n\n### Run Tests \u003ca name=\"run-tests\"\u003e\u003c/a\u003e\n   \nTo execute tests:\n          \n                rails test:all\n        \n\n\u003ca name=\"contributors\"\u003e\u003c/a\u003e\n\n##  Contributors\n\n👤 **Author1**\n\n- GitHub: [@AlierPM](https://github.com/AlierPM)\n- Twitter: [@AlierPM](https://twitter.com/AlierPM)\n- LinkedIn: [@AlierPM](https://linkedin.com/alier-philip-maguet)\n\n\n\n\u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n##  Future features?\n\n- Add user authentication and authorization.\n- Add more greetings to the database.\n- Add a feature to create and store new greetings.\n\n\u003ca name=\"lets-collaborate\"\u003e\u003c/a\u003e\n\n##  Let's Collaborate\n\n- Feel free to contribute to the project by forking it and submitting a pull request.\n\n\u003ca name=\"star-it\"\u003e\u003c/a\u003e\n\n## ⭐️ Star It\n\n- If you find this project useful, please give it a star.\n\n\u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\n##  Acknowledgments\n\n- [Microverse](https://www.microverse.org)\n- [Rails Guides](https://guides.rubyonrails.org/)\n\n\n\u003ca name=\"faq\"\u003e\u003c/a\u003e\n\n## ❓ FAQ\n\n- **How do I report a bug or request a feature?**\n  - Please open an issue on the GitHub repository.  \n\n\u003ca name=\"license\"\u003e\u003c/a\u003e\n\n##  License\n\nThis project is [MIT](./License) licensed.\n\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\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falierpm%2Fhello-rails-back-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falierpm%2Fhello-rails-back-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falierpm%2Fhello-rails-back-end/lists"}