Welcome to the API Smith! This is an application for RPG lovers built on Node.JS using Jest, TypeScript and OOP.
To install the API Smith, please follow the steps below:
-
Ensure that you have Node.js at version 18 and npm installed on your computer. If you don't, you can download them from the official Node.js website https://nodejs.org/en/. I recommend NVM for the manage of node's version, you can download it from the official nvm repository https://github.com/nvm-sh/nvm.
-
Clone this repository to your local machine using the following command:
git clone git@github.com:ramonbs/smith_api.git
- Navigate into the project directory:
cd smith_api
- Install the required dependencies using npm:
npm install
This command will install all the required packages, including ESLint, RTL, and Jest.
To run the aplication, use the following command:
npm run dev
To test the aplication, use the following command:
npm run test
This will start a development server, which will allow you to view the application in your web browser. By default, the game will be available at http://localhost:5173.