{"id":22218154,"url":"https://github.com/ridwanullahi-code/countriesapi","last_synced_at":"2025-03-25T07:17:23.533Z","repository":{"id":233619178,"uuid":"787553877","full_name":"Ridwanullahi-code/CountriesAPI","owner":"Ridwanullahi-code","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-23T12:19:45.000Z","size":662,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T06:29:29.061Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://countries-api-six-sooty.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ridwanullahi-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-04-16T18:38:59.000Z","updated_at":"2024-05-02T18:55:39.000Z","dependencies_parsed_at":"2024-12-02T22:19:59.368Z","dependency_job_id":"986f986c-d200-446f-89df-62212a5c6af9","html_url":"https://github.com/Ridwanullahi-code/CountriesAPI","commit_stats":null,"previous_names":["ridwanullahi-code/countriesapi"],"tags_count":0,"template":true,"template_full_name":"Ridwanullahi-code/readme-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ridwanullahi-code%2FCountriesAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ridwanullahi-code%2FCountriesAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ridwanullahi-code%2FCountriesAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ridwanullahi-code%2FCountriesAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ridwanullahi-code","download_url":"https://codeload.github.com/Ridwanullahi-code/CountriesAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245414551,"owners_count":20611367,"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-12-02T22:19:24.989Z","updated_at":"2025-03-25T07:17:23.506Z","avatar_url":"https://github.com/Ridwanullahi-code.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n  ![CountriesAPI Logo](./countries.webp)\n\n\u003c/div\u003e\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  - [🚀 Live Demo](#live-demo)\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- [❓ FAQ](#faq)\n- [📝 License](#license)\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n# 📖 CountriesAPI \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\nCountriesAPI is a robust and user-friendly API designed to provide comprehensive information about countries worldwide. Whether you're a developer building a global application, a researcher analyzing international trends, or an enthusiast curious about different cultures, CountriesAPI offers easy access to a wealth of country data.\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\u003eServer\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://expressjs.com/\"\u003eExpress.js\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://www.typescriptlang.org/\"\u003eTypeScript\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://mongoosejs.com/\"\u003eMongoose\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n## Base URL\n\nThe base URL for the CountriesAPI is:\n\nhttps://countriesapi-production-3385.up.railway.app\n\n### Retrieve All Countries\nTo retrieve all countries, send a GET request to the following endpoint:\n\n```sh\nhttps://countriesapi-production-3385.up.railway.app/countries\n```\n\nFor detailed information on available endpoints and how to use them, please refer to the [API documentation](https://app.swaggerhub.com/apis-docs/RIDWANULLAHIAJAYI01/country-api/1.0.0)\n\n\u003c!-- LIVE DEMO --\u003e\n## 🚀 Live Demo \u003ca name=\"live-demo\"\u003e\u003c/a\u003e\n\n- Explore the demo of CountriesAPI to see it in action! [Live Demo Link](https://app.swaggerhub.com/apis-docs/RIDWANULLAHIAJAYI01/country-api/1.0.0)\n\n## Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\nCountriesAPI offers a wide range of features to meet your needs:\n\n- **Comprehensive Data**: Access detailed information about countries, including demographics, geography, economy, and more.\n- **Flexible Querying**: Search and filter countries based on various criteria such as population size, GDP, region, and language.\n- **Localized Information**: Retrieve data in multiple languages and currencies to support global applications.\n- **Scalable and Performant**: Built with scalability in mind, ensuring fast response times even with large datasets.\n- **Developer-Friendly**: Easy-to-use API endpoints with clear documentation and code examples for seamless integration.\n\nWith CountriesAPI, you have everything you need to build powerful applications with global reach. Whether you're developing a travel app, conducting research, or simply exploring the world, CountriesAPI is your go-to resource for accurate and up-to-date country information.\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\nTo get started with the Country API, make sure you have the following prerequisites installed:\n\n- **Node.js**: Ensure that you have Node.js installed on your system. You can download it from the [official Node.js website](https://nodejs.org/).\n\n- **PostgreSQL** (Optional): If you plan to use a database with the API, PostgreSQL is recommended. You can download it from the [official PostgreSQL website](https://www.postgresql.org/download/).\n\n### Setup\n\nClone this repository to your desired folder:\n\n```sh\ngit clone https://github.com/Ridwanullahi-code/CountriesAPI.git\n```\n\n### Change Directory\n\n```sh\ncd CountriesAPI\n```\n\n### Install\n\n```sh\n npm install\n```\n\n### Database Migration\n\n```sh\nnpm run migrate:init\n```\n\n### Usage\n\n```sh\nnpm start\n```\n### Run tests\n\n```sh\nnpm test\n```\n### Deployment\n\n\u003c!-- AUTHORS --\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Author1**\n\n- GitHub: [@githubhandle](https://github.com/Ridwanullahi-code)\n- Twitter: [@twitterhandle](https://twitter.com/Ridwanullahi22)\n- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ajayi-ridwan/)\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n- **Implement endpoint for retrieving country details by name**\n- **Add authentication for certain endpoints**\n- **Integrate caching mechanism to improve performance**\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. [issues page](../../issues/).\n\n\u003c!-- SUPPORT --\u003e\n\n## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nPlease share this project with your classmates and Star this repository by clicking on ⭐ button above.\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgements\"\u003e\u003c/a\u003e\n\nI would like to thank all my classmates who contributed to the development of this project.\n\n\u003c!-- FAQ (optional) --\u003e\n\n## ❓ FAQ \u003ca name=\"faq\"\u003e\u003c/a\u003e\n\n- ### How can I contribute to the CountriesAPI project?\n\u003e- You can contribute to the project by submitting bug reports, feature requests, or pull requests. We welcome any contributions that can improve the project.\n\n- ### Is the CountriesAPI project free to use?\n\u003e- Yes, the CountriesAPI project is free to use for both personal and commercial purposes. However, we appreciate if you credit us when using the API in your projects.\n\n- ### Can I request a new feature for the CountriesAPI project?\n\u003e- Absolutely! We encourage users to suggest new features that can enhance the functionality of the API. Feel free to open an issue on GitHub with your feature request.\n\n- ### How often is the data in the CountriesAPI project updated?\n\u003e- The data in the CountriesAPI project is updated regularly to ensure accuracy and completeness. We strive to provide the most up-to-date information about countries worldwide.\n\n- ### Are there any rate limits for accessing the CountriesAPI project?\n\u003e- No, there are no rate limits for accessing the CountriesAPI project. You can make as many requests as you need without any restrictions.\n\n- ### Where can I report bugs or issues with the CountriesAPI project?\n\u003e- You can report bugs or issues with the CountriesAPI project by opening an issue on GitHub. Please provide detailed information about the problem you encountered, including steps to reproduce it.\n\n- ### Is there any documentation available for the CountriesAPI project?\n\u003e- Yes, we provide documentation for the CountriesAPI project to help users understand how to use the API and its endpoints. You can find the documentation in the main [website]().\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridwanullahi-code%2Fcountriesapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fridwanullahi-code%2Fcountriesapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fridwanullahi-code%2Fcountriesapi/lists"}