BrunoPierca/toolbox-test-app

Full stack application for technical purposes

Toolbox test app

This is a full stack application developed using Express & React with vanilla JS

API Documentation

Live demo

Run Locally

Clone the project

  git clone https://github.com/BrunoPierca/toolbox-test-app/

With docker

navigate to the root folder of the project and run

  docker-compose up

You will see backend test results and then both parts will be available. By default, the frontend is at port 3000 and the backend at 5000

Manually running the project

Navigate to each folder (backend & frontend) and install required modules

  npm install

Running the projects, both projects start their execution running the default start command:

  npm start

API Reference

Get file list

  GET /files/list

Get all files

  GET /files/data

Get one file

  GET /files/data?fileName=example1.csv

Parameter	Type	Description
fileName	string	Use a fileName present on the file list provided by /files/list

Get API documentation

  GET /docs

Running Tests

To run tests on the backend, run the following command inside the "backend" directory

  npm run test