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.
file-uploads-api/README.md
2022-04-08 17:54:56 +02:00

2.2 KiB

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