Filesystem API

Introduction

This project is a filesystem API implementation using Golang.

Prerequisites

Make sure you have the following installed on your machine:

• Go (version 1.20 or higher)
• Node.js (for the dev target in the Makefile with Nodemon)

Installation

1. Clone the repository:

   git clone https://github.com/dbsSensei/filesystem-api.git

2. Change into the project directory:

   cd filesystem-api

3. Install project dependencies:

   make deps

4. Rename file app.env.example to app.env

Usage

Build

To compile the packages, run the following command:

make build

Run

To build and run the project in development mode, use the following command:

make run

This will compile the packages and start the application.

Clean

To clean the project and remove previous builds, run:

make clean

Development Mode

To run the project in development mode using nodemon (requires Node.js), use the following command:

make dev

This will automatically restart the application whenever changes are made.

Generate API Documentation V1

To generate API documentation using Swag, run:

make generatedocs1

This will create the documentation in the docs/v1 directory.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.