Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.81 KB

README.md

File metadata and controls

43 lines (32 loc) · 1.81 KB
Raw

ASEAN-API-V2

The API for ASEAN BTE to get memes build sites and more!

Prerequisites

Before starting working on this project, please make sure you have already installed following tools:

Installation Steps

  1. Fork the repository
  2. Clone the project
  3. Navigate to the project directory, cd ASEAN-API-V2
  4. Install dependencies with npm install
  5. Run npm start

Contributing

Here are few ways you can contribute to this project

  • If there are bugs, raise issues
  • Fix the bugs
  • Add more JSON data

Steps to add JSON data

  • Find the JSON file to which you are going to add the data.
    • All the JSON data files are present in the data directory.
    • Each category's JSON files are present in seprate folders.
      • Such as the cat related JSON files are present in data/cat.
  • Finding the right images/gifs.
    • After finding the images/gifs, upload them to imgur, this will make the JSON files seem consistent.
    • If you want a MP4 to be used, then upload it to imgur and copy it's link and add .gif to the end and paste the link in the JSON file
  • Avoid duplicate gifs/images. Double check if the gif/image link exists in the JSON data already or not

Contributors

Thanks a lot for taking your time out and contributing to this project