Thream's application programming interface (API) to upload files. https://file-uploads-api.thream.divlo.fr/documentation
This repository has been archived on 2024-10-29. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2022-04-08 19:37:55 +00:00
.github chore: initial commit 2022-04-08 17:54:56 +02:00
.husky chore: initial commit 2022-04-08 17:54:56 +02:00
.vscode chore: initial commit 2022-04-08 17:54:56 +02:00
src feat: add API Key security for POST uploads 2022-04-08 18:46:36 +02:00
uploads chore: initial commit 2022-04-08 17:54:56 +02:00
.commitlintrc.json chore: initial commit 2022-04-08 17:54:56 +02:00
.editorconfig chore: initial commit 2022-04-08 17:54:56 +02:00
.env.example build(deps): add @semantic-release/git 2022-04-08 21:35:27 +02:00
.eslintrc.json chore: initial commit 2022-04-08 17:54:56 +02:00
.gitattributes chore: initial commit 2022-04-08 17:54:56 +02:00
.gitignore feat: add API Key security for POST uploads 2022-04-08 18:46:36 +02:00
.lintstagedrc.json chore: initial commit 2022-04-08 17:54:56 +02:00
.markdownlint.json chore: initial commit 2022-04-08 17:54:56 +02:00
.npmrc chore: initial commit 2022-04-08 17:54:56 +02:00
.prettierrc.json chore: initial commit 2022-04-08 17:54:56 +02:00
.releaserc.json chore: initial commit 2022-04-08 17:54:56 +02:00
.swcrc chore: initial commit 2022-04-08 17:54:56 +02:00
CODE_OF_CONDUCT.md chore: initial commit 2022-04-08 17:54:56 +02:00
CONTRIBUTING.md chore: initial commit 2022-04-08 17:54:56 +02:00
LICENSE chore: initial commit 2022-04-08 17:54:56 +02:00
package-lock.json chore(release): 1.0.0 [skip ci] 2022-04-08 19:37:55 +00:00
package.json chore(release): 1.0.0 [skip ci] 2022-04-08 19:37:55 +00:00
README.md chore: initial commit 2022-04-08 17:54:56 +02:00
tsconfig.json chore: initial commit 2022-04-08 17:54:56 +02:00

Thream/file-uploads-api

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 https://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

  • API : http://localhost:8000

💡 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