Giter Club home page Giter Club logo

toolbox's Introduction

Full Stack JS - Code Challenge - Solution

This project contains a Full Stack JavaScript application that consumes data from an external API and presents it in an organized manner on the frontend. The API and the frontend are containerized using Docker and can be run together using Docker Compose.

Prerequisites

Make sure you have the following installed on your system:

Getting Started

  1. Clone this repository to your local machine:
git clone <repository_url>
cd <repository_name>
  1. Build the Docker images:
docker-compose build
  1. Run the application using Docker Compose:
docker-compose up

This will start both the API server and the frontend client.

API

Endpoint

The API serves data at the following endpoint:

GET http://localhost:3000/files/data

API Key

The API requires an API Key to access the external API. The API Key is "Bearer aSuperSecretKey".

API Documentation

For detailed API documentation, refer to the Swagger UI provided by the external API: API Externo - Swagger

Optional Endpoints

Frontend

Access

Access the frontend client at: http://localhost:3000

Layout

The frontend client displays the data obtained from the API in an organized layout.

Optional Features

  • Redux is used for state management in the frontend.
  • Jest is used for unit testing the API.
  • Filtering by "fileName" is implemented using the optional API endpoint and query parameter.

Notes

  • The API runs on Node.js 14, and the frontend client runs on Node.js 16.
  • The API and frontend do not depend on globally installed libraries or OS-specific configurations.
  • The API is written in JavaScript (ES6+), and no transpilers like Babel or TypeScript are used.
  • The frontend is written using React, React Bootstrap, and functional programming with Hook Effects.
  • Docker is used for containerizing the application, making it easy to deploy and run in different environments.

License

This project is licensed under the MIT License.

toolbox's People

Watchers

Jonathan diaz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.