Skip to content

rccastro16/marvel-characters-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

marvel-characters-api

Getting Started These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installing

Clone repo to your directory

Once completed we will create an .env file in the root folder. This file will contain all of the configurations and api keys we will use for the app.

PORT=8080
REDIS_URL=redis://localhost:6379

MARVEL_PUBLIC_API_KEY={public_key}
MARVEL_PRIVATE_API_KEY={private_key}

In the terminal run:

npm install

This will install all the dependencies of the project

Once completed, we can now start the application by running:

npm run dev

Running the tests

In order to test the app run:

npm run test

Swagger API Documentation

A complete API Documentation can be accessed in this link.

http://localhost:8080/api-docs/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published