Thream/file-uploads-api

⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.

📜 About

Thream's application programming interface (API) to upload files.

⚙️ Getting Started

Prerequisites

• Node.js >= 16.0.0
• npm >= 8.0.0

Installation

# Clone the repository
git clone git@github.com:Thream/file-uploads-api.git

# Go to the project root
cd file-uploads-api

# Configure environment variables
cp .env.example .env

# Install
npm install

You will need to configure the environment variables by creating an .env file at the root of the project (see .env.example).

Usage

npm run dev

Services started

• file-uploads-api: http://127.0.0.1:8000

Production environment (with Docker)

docker compose up --build

💡 Contributing

Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.

The steps to contribute can be found in CONTRIBUTING.md.

📄 License

MIT