Skip to content
This repository was archived by the owner on Oct 17, 2024. It is now read-only.

Testing

Jump to bottom
Yash Aryan edited this page Jul 23, 2020 · 4 revisions

If you want to test this API on your localhost, or you want to make modifications to it to soothe your own tastes, here's how you can set it up.

Cloning the repository

First of all, clone the repo using git clone https://github.com/var-greyShader/slcmAPI.git or downloading it directly using the following button.
Download now

System Requirements

Make sure you have the following requirements met before you try to test this API.

  • Node.js installed on your machine. Download it from [here] (https://nodejs.org/en/). If you are running a very old version, code might break. This one was made using LTS v12.13.0.
  • NPM installed so that you can install all the packages required for the code to run smoothly. This one was made using version 6.13.7
    NPM is bundled with Node.js, so when you download and install Node, you'll already have NPM installed on your machine.
  • Postman is recommended to test the API if you find it tough/inconvenient to write HTTP requests from your command prompt/terminal. You can download it from here. (optional)

Installing all the packages

Now that you have the environment is set, it is time to test the code. First of all, if your downloaded file is in ZIP format, extract it and place it in the folder you'll want it to live. Now open a terminal in the folder of the code and type npm install. All of the packages needed to run the server will be installed. After installation is completed, type node server.js to run the server. The server is now running on http://localhost:3000/

Created by greyShader

Clone this wiki locally