https://github.com/tadashi-aikawa/miroir

Viewer for jumeaux.
https://github.com/tadashi-aikawa/miroir

Last synced: 25 days ago
JSON representation

Viewer for jumeaux.

• Host: GitHub
• URL: https://github.com/tadashi-aikawa/miroir
• Owner: tadashi-aikawa
• License: gpl-3.0
• Created: 2017-01-29T12:16:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T17:12:48.000Z (almost 2 years ago)
• Last Synced: 2024-04-12T15:44:00.082Z (7 months ago)
• Language: TypeScript
• Homepage: https://tadashi-aikawa.github.io/miroir
• Size: 8.26 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Miroir

======



Viewer for [jumeaux](https://github.com/tadashi-aikawa/jumeaux).

📜 Documentation

------------------

https://tadashi-aikawa.github.io/miroir

☁ AWS Setup

------------

```

$ ./setup-aws.sh  

```

`./setup-aws.sh -h` shows usages and a example.

💻 Develop

------------

### Preparation for development

```

$ npm install

```

### Development server

```

$ make dev

```

Then access to `http://localhost:4200/`

### Serve documentation

```

$ make serve-docs

```

📦 Release

------------

**Window is OK!! Good 👍**

1. `make add-release-note version=x.y.z` for createing `docs/releases/*.md`

2. Update `docs/_sidebar.md`

3. Update version in `docs/index.md`

4. Check Miroir and documentation

Then

```

make release version=x.y.z

```

Deploy

------

### Packaging

```

$ make package

```

### Deploy by docker

```

$ make deploy-container

```

Then access to `http://localhost:8888/miroir`

### Deploy to S3

```

$ make deploy-s3 BUCKET=your-miroir-bucket

```