Table of Contents
The Country Information API is a Node.js and Express.js-based application that provides information about countries. Users can retrieve data about specific countries or get a list of all countries.
To run this project locally and access the API, follow these steps:
You'll need to have the following software installed on your machine:
- Node.js and npm - Download Here
- Clone the repository:
git clone https://github.com/your_username/country-information-api.git
- Navigate to the project directory:
cd country-information-api - Install the project dependencies:
npm install
- Start the server:
The API will be available at http://localhost:3001.
npm start
You can use this API to retrieve information about countries. There are two main endpoints:
- To get a simple instruction, make a GET request to:
http://localhost:3001/- To get a list of all countries, make a GET request to:
http://localhost:3001/all- To get information about a specific country, make a GET request to:
http://localhost:3001/country/{country-name}- Implement basic API functionality
- Add error handling and logging
- Add automated test
- Implement authentication and authorization
- Add support for additional data fields See the open issues for a list of proposed features and known issues.
Contributions are welcome! Here's how you can get involved:
Forkthe Project- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a
Pull Request
Distributed under the MIT License.
Here are some resources and tools that were used in the development of this project:
- Node.js
- Express.js
- Axios
- Jest
- Supertest