Skip to content

Commit

Permalink
feat(ci-cd): CI/CD | 010 - Setup Environments (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
poly-glot authored Apr 5, 2020
1 parent a01426c commit 00b6333
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 45 deletions.
54 changes: 10 additions & 44 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,36 +1,19 @@
# front-end-starter-kit
![CI/CD](https://github.com/poly-glot/vanilla-front-end-starter/workflows/CI/CD/badge.svg)
[![codecov](https://codecov.io/gh/poly-glot/vanilla-front-end-starter/branch/master/graph/badge.svg?token=K6AIDS2WN8)](https://codecov.io/gh/poly-glot/vanilla-front-end-starter)
[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/poly-glot/vanilla-front-end-starter)
[![Cypress.io Dashboard](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://dashboard.cypress.io/projects/8joug9/runs)
[![DeepScan grade](https://deepscan.io/api/teams/8408/projects/10599/branches/148870/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=8408&pid=10599&bid=148870)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/poly-glot/vanilla-front-end-starter)
# tensorflowjs-remove-background
![CI/CD](https://github.com/poly-glot/tensorflowjs-remove-background/workflows/CI/CD/badge.svg)
[![codecov](https://codecov.io/gh/poly-glot/tensorflowjs-remove-background/branch/master/graph/badge.svg)](https://codecov.io/gh/poly-glot/tensorflowjs-remove-background)
[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/poly-glot/tensorflowjs-remove-background)
[![Cypress.io Dashboard](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://dashboard.cypress.io/projects/jp2thc/runs)
[![DeepScan grade](https://deepscan.io/api/teams/8408/projects/10623/branches/149386/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=8408&pid=10623&bid=149386)
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/poly-glot/tensorflowjs-remove-background)

A vanilla front-end starter kit with tools to support code quality, accessibility, unit testing, end to end testing,
continuous integration setup and feature branch testing.

## Who it is for
Suitable for responsive sites or simple applications in a fast pace delivery environment with
shared nothing front-end architecture using vanilla js. However, code should be isolated & independent where possible to allow us to
take benefits of previous projects and experience.

## List of tools
- Code Quality: Eslint, Stylelint & Deepscan
- Unit Testing: Jest + Enzyme
- End to End testing: Cypress.io + Percy.io
- CI: Github Actions
Remove Background from picture using WebAssembly & TensorFlow.js

# Getting Started
```
npm install
npm start
```

## Adding a new Feature
- Familiarise yourself with Gitflow and checkout a feature branch from master e.g. feature/awesome-feature.
- Keep your feature branch upto date with master.
- Use <a href="https://www.conventionalcommits.org/">Conventional Commits spec</a> e.g. (fix/feat/refactor/refactor!) | Component | Task ID - Small Description

## Manual Review Guidelines
<table width="100%">
<tr>
Expand All @@ -55,9 +38,6 @@ npm start
</tr>
</table>

# Estimation Guide for Static Projects
(TODO)

# Local Development

### Running Github Action
Expand All @@ -76,23 +56,9 @@ docker run -ti -v $(pwd)/src:/root/src --link sonarqube newtmitch/sonar-scanner

### Docker
```
docker build -t vanilla-front-end-starter .
docker run -it --rm -p 5000:5000 vanilla-front-end-starter
docker build -t tensorflowjs-remove-background .
docker run -it --rm -p 5000:5000 tensorflowjs-remove-background
```

# Browser Support
2 most recent versions of Chrome, Firefox, Safari & MS Edge.

# Todo
- Feature : CI/CD - Add Docker preview.
- Feature : CI/CD - Add automatic release after every two weeks.

# Github Secrets
- ZEIT_TOKEN
- NOW_ORG_ID
- NOW_PROJECT_ID_STATIC
- PERCY_TOKEN
- CYPRESS_RECORD_KEY
- CODECOV_TOKEN

# Non functional Requirements
2 changes: 1 addition & 1 deletion cypress.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"defaultCommandTimeout": 60000,
"projectId": "8joug9"
"projectId": "jp2thc"
}

1 comment on commit 00b6333

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for website ready!

Built with commit 00b6333

https://https://tensorflowjs-remove-background-8yetsvv19.now.sh

Please sign in to comment.