Code Monkey home page Code Monkey logo

fila's Introduction

Fila

Fila is an application for working with file metadata. You can store your file metadata, retrieve, and delete specific file information via REST endpoints.

Built With

This project is built with the following tools:

Prerequisites

Getting Started

To setup a local copy of the project, clone the repository by running the command below in your terminal.

git clone https://github.com/codeBlock-1984/fila.git

Installation

  1. To install the project packages, navigate to the project root and run the command below:
    npm install
  2. Create a .env file in the project root directory. Copy the entire contents of .env.sample and paste into the .env file you created. Set the values of the .env file keys appropriately and save the file.

Usage

To start the local server run the command below:

npm run serve

You should see the message Fila server is listening on port <PORT>... in the console.

In this section <PORT> will refer to the value of the PORT key in your local .env

  1. Create a file metadata: To create a file metadata record, send a POST request
curl -d '{"name":"test file", "size":1024, "format": "PDF"}' -H "Content-Type: application/json" -X POST http://localhost:<PORT>/api/v1/files/
  1. Get all saved file metadata: To fetch all file metadata records, send a GET request
curl -X GET http://localhost:<PORT>/api/v1/files/
  1. Get a specific file metadata: To fetch a file metadata record with <id>, send a GET request
curl -X GET http://localhost:<PORT>/api/v1/files/<id>
  1. Delete a file metadata: To delete a file metadata record with <id>, send a GET request
curl -X DELETE http://localhost:<PORT>/api/v1/files/<id>

License

Distributed under the MIT License. See LICENSE.txt for more information.

fila's People

Contributors

codeblock-1984 avatar

Watchers

 avatar  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.