mirror of
https://github.com/Thream/file-uploads-api.git
synced 2024-07-02 02:40:12 +02:00
Thream's application programming interface (API) to upload files.
https://file-uploads-api.thream.divlo.fr/documentation
| .github | ||
| .husky | ||
| .vscode | ||
| src | ||
| uploads | ||
| .commitlintrc.json | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .lintstagedrc.json | ||
| .markdownlint-cli2.jsonc | ||
| .npmrc | ||
| .prettierrc.json | ||
| .releaserc.json | ||
| .swcrc | ||
| CODE_OF_CONDUCT.md | ||
| compose.yaml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
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
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.