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 - [Node.js](https://nodejs.org/) >= 16.0.0 - [npm](https://www.npmjs.com/) >= 8.0.0 ### Installation ```sh # 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 ```sh npm run dev ``` #### Services started - `file-uploads-api`: ### Production environment (with [Docker](https://www.docker.com/)) ```sh 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](./CONTRIBUTING.md). ## 📄 License [MIT](./LICENSE)