An open API service indexing awesome lists of open source software.

https://github.com/nutfes/seeft-api


https://github.com/nutfes/seeft-api

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# SeeFT-API

## Features

## Requirement
`production`
- dart
- docker

`dev`
- mysqldef
but run `./scripts/script.sh`

## Installation

``` fish
$ docker compose build
$ docker comopose up -d
$ ./scripts/script.sh
$ ./sql/migrate.sh
$ docker compose run --rm server dart ./sql/sql.dart seed
```

## Usage

``` fish
$ docker compose up
```

## Deployment

mysqldefがあったら `./sciripts/script.sh`は実行しなくて良い

``` fish
$ docker compose build
$ docker compose up -d
$ ./scripts/script.sh
$ ./sql/migrate.sh
$ docker compose run --rm server dart ./sql/sql.dart seed
$ docker compose run --rm server dart ./sql/sql.dart user ./sql/user.csv
```

### logを表示させたい時

``` fish
$ docker compose up -d
$ docker logs SeeFT-API -f
```

## Note
### プルリクでFormatterが失敗した時

``` fish
$ docker compose run --rm server dart format ./ -l 120 --set-exit-if-changed
```

### .shスクリプトが動かない場合

```
$ chmod u+x ./scripts/script.sh
$ chmod u+x ./sql/migrate.sh
```

### docker-compose upでAPIが経たない時

```
$ docker compose run --rm server dart pub get
```

### diを編集してからうまく動かないとき
一度コンテナをdownさせてからupし直してみてください。

## Author
NUTMEG(技大祭実行委員会情報局)
mail: nutfes.info [at] gmail