Skip to content

Latest commit

 

History

History
240 lines (182 loc) · 8.18 KB

README.vietnamese.md

File metadata and controls

240 lines (182 loc) · 8.18 KB

My Hero Academia API

Forks Stars Issues MIT License

This README was translated into Vietnamese by KimLong1234567. Last translation (November 17th 2022), final update (January 12th 2023).

Table of contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Đây là một dự án API do fan làm vì đam mê. Tôi rất thích anime và một trong những bộ yêu thích gần đây của tôi là My Hero Academia, vì vậy tôi quyết định tạo ra thứ gì đó cho nó và dựa trên cơ sở của fan nên tôi tạo ra API này.

Built with

JavaScript

Node.js

Express.JS

Heroku

Jest

Prettier

(Back to top)

Getting Started

Để tạo và chạy một bản sao cục bộ, hãy làm theo các bước ví dụ đơn giản sau.

Prerequisites

Để sử dụng dự án này, bạn sẽ cần cài đặt trình quản lý gói node. Vào npm documentation để được hướng dẫn chi tiết hơn.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/pattisoj/my-hero-academia-api.git
  2. Install NPM packages
    npm install
  3. Run the api locally
    npm start
    NOTE - When running locally this API will use http://localhost:3000/. If you need to change this for any reason the port can be found in .bin/www.js. Do not commit any port changes on a pull request.

(Back to top)

Usage

Không gian này sẽ được cập nhật cùng với sự phát triển của API.

Yêu cầu có thể được thực hiện với curl hoặc các thư viện trợ giúp khác bằng cách thực hiện theo các lệnh gọi REST thông thường. Ví dụ: đây là cách GET tất cả dữ liệu ký tự:

curl https://myheroacademia-api.onrender.com/characters

Gọi tài nguyên này sẽ phản hồi với một đối tượng có cấu trúc sau:

{"students" : [
  {
  "id": "1",
  "name": "Izuku Midoriya",
  "name_japanese": "緑谷 出久",
  "other_names": ["Deku"],
  "quirk": "One for All",
  "quirk_japanese": "ワン・フォー・オール",
  "quirk_description": "A transferable Quirk that stockpiles power and grants immense strength, speed, stamina, and durability.",
  "hero_school": "U.A. High School",
  "class": "Class 1-A"
  },
  ...],
"villains" : [
  {
  "id" : "46",
  "name" : "Tenko Shimura",
  "name_japanese" : "志村 転弧",
  "other_names" : ["Tomura Shigaraki"],
  "quirk" : "Decay",
  "quirk_japanese" : "崩壊",
  "quirk_description" : "Enables him to disintegrate whatever he touches with his fingers and anything connected to it.",
  "affiliation" : "League of Villains"
  },
  ...],
"heroes" : [
  {
  "id" : "92",
  "name" : "Enji Todoroki",
  "name_japanese" : "轟 炎司",
  "hero_name" : "Endeavor",
  "hero_name_japanese" : "エンデヴァー",
  "quirk" : "Hellflame",
  "quirk_japanese" : "ヘルフレイム",
  "quirk_description" : "Gives him powerful pyrokinetic abilities. He is immune to other flames, and can easily control the shape and temperature of the blaze as well.",
  "affiliation" : "Top Hero"
  },
  ...]
}

For data on a single character you can search by id:

curl https://myheroacademia-api.onrender.com/characters/{characterID}

Hiện tại có dữ liệu của 57 học sinh, 46 nhân vật phản diện và 42 anh hùng.

Endpoints

  • /characters
    • /students
    • /villains
    • /heroes
    • /{characterID}

(Back to top)

Roadmap

  • Deployment
  • CI/CD Pipelines
    • Auto-deployment
    • Linting workflow
    • Testing workflow
    • Contribution guides
  • Data for all characters
    • Students
    • Villains
    • Pro Heroes
    • Other
  • Episode Information
    • Main
    • Movies
    • Specials (OVAs)

See the open issues for a full list of proposed features (and known issues).

(Back to top)

Contributing

Đóng góp là những gì làm cho cộng đồng nguồn mở trở thành một nơi tuyệt vời để học hỏi, truyền cảm hứng và sáng tạo. Bất kỳ đóng góp nào bạn thực hiện đều được đánh giá cao.

Nếu bạn có đề xuất nào có thể cải thiện điều này, vui lòng rẽ nhánh repo và tạo yêu cầu kéo. Bạn cũng có thể chỉ cần mở một vấn đề với thẻ "cải tiến". Đảm bảo bạn đưa ra mô tả về những thay đổi của mình. Đừng quên cho dự án một ngôi sao! Cảm ơn một lần nữa!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(Back to top)

License

Phân phối theo Giấy phép MIT. Xem LICENSE.txt để có nhiều thông tin hơn.

(Back to top)

Contact

Twitter

Linkedin

Portfolio

ProjectLink

(Back to top)

Acknowledgments

(Back to top)