Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/amercier/tools

A set of tools for web development
https://github.com/amercier/tools

development tools web

Last synced: 3 months ago
JSON representation

A set of tools for web development

Awesome Lists containing this project

README

        

# amercier/tools

> My personal toolkit for web development.
> https://tools.amercier.com

[![Build Status](https://travis-ci.org/amercier/tools.svg?branch=master)](https://travis-ci.org/amercier/tools)
[![Test Coverage](https://img.shields.io/codecov/c/github/amercier/tools/master.svg)](https://codecov.io/github/amercier/tools?branch=master)
[![Technical Debt](https://img.shields.io/codeclimate/tech-debt/amercier/tools.svg)](https://codeclimate.com/github/amercier/tools)

# Development

This project is developped using [React](https://reactjs.org/).

[![dependencies Status](https://david-dm.org/amercier/tools/status.svg)](https://david-dm.org/amercier/tools)
[![devDependencies Status](https://david-dm.org/amercier/tools/dev-status.svg)](https://david-dm.org/amercier/tools?type=dev)

## Setup

1. Requirements: [Node.js](https://nodejs.org/en/) (latest) and `npm`.
2. Clone this repository: `git clone {REPOSITORY URL}`
3. Install dependencies:

```sh
npm install
```

## Run

```sh
npm start
```

## Test

```sh
npm test
```

# Deployment

Website https://tools.amercier.com/ is hosted on [Amazon S3][1] and served by
[Amazon CloudFront][2], as described in [this blog post][3].

## Continuous deployment

1. Each commit triggers a build on [Travis CI][4] (2 on Pull Requests commits).
Successful builds on `master` branch trigger deployment on [Amazon S3][1]
automatically.
2. Additionally, weekly builds are triggered automatically. It does not trigger
any deployment.

[1]: https://aws.amazon.com/s3/
[2]: https://aws.amazon.com/cloudfront/
[3]: https://medium.com/@willmorgan/moving-a-static-website-to-aws-s3-cloudfront-with-https-1fdd95563106
[4]: https://travis-ci.org/amercier/tools

## Manual deployment

```sh
npm run build
```

This creates a `build` directory containing the static files to deploy.

## License

[![License](https://img.shields.io/github/license/amercier/tools.svg)](LICENSE.md)