Skip to content
This repository has been archived by the owner on Dec 28, 2023. It is now read-only.
/ file-uploads-api Public archive

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

License

Notifications You must be signed in to change notification settings

Thream/file-uploads-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Licence MIT Contributor Covenant

Conventional Commits semantic-release

📜 About

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

⚙️ Getting Started

Prerequisites

Installation

# Clone the repository
git clone [email protected]: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

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