https://github.com/solvro/backend-topwr

https://github.com/solvro/backend-topwr

adonis api backend pwr rest student students wust

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/solvro/backend-topwr
• Owner: Solvro
• License: agpl-3.0
• Created: 2024-11-13T18:36:47.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-16T08:29:04.000Z (6 days ago)
• Last Synced: 2024-12-16T09:20:51.367Z (6 days ago)
• Topics: adonis, api, backend, pwr, rest, student, students, wust
• Language: TypeScript
• Homepage:
• Size: 1.28 MB
• Stars: 17
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ToPWR Backend

![Solvro banner](https://github.com/Solvro/backend-topwr-sks/blob/main/assets/solvro_dark.png#gh-dark-mode-only)

![Solvro banner](https://github.com/Solvro/backend-topwr-sks/blob/main/assets/solvro_dark.png#gh-light-mode-only)

## Links

[![docs.solvro.pl](https://i.imgur.com/fuV0gra.png)](https://docs.solvro.pl)

## Drive

### Theory

For storing files we use LocalFile System -> just folder in our environment.

Make sure that folder `storage` is added in gitignore and don't push it into github.

### How to use

To unify our style of using storage we have `FilesService`

Example of usage you can see in below or in `app/controllers/files_controller.ts` and `start/routes.ts`

```ts

import { inject } from "@adonisjs/core";

import type { HttpContext } from "@adonisjs/core/http";

import FilesService from "#services/files_service";

export default class FilesController {

  @inject()

  async post({ request, response }: HttpContext, filesService: FilesService) {

    const file = request.file("file");

    if (!file) {

      return response.badRequest("No file provided");

    }

    const key = await filesService.uploadFile(file);

    if (key instanceof Error) {

      return response.badRequest(key.message);

    }

    return response.status(201).send({ key });

  }

  @inject()

  async get({ params, response }: HttpContext, filesService: FilesService) {

    const { key } = params;

    const url = await filesService.getFileUrl(key);

    if (url instanceof Error) {

      return response.badRequest(url.message);

    }

    return response.status(200).send({ url });

  }

}

```