Skip to content

Commit 00b6333

Browse files
authored
feat(ci-cd): CI/CD | 010 - Setup Environments (#1)
1 parent a01426c commit 00b6333

File tree

2 files changed

+11
-45
lines changed

2 files changed

+11
-45
lines changed

README.MD

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,19 @@
1-
# front-end-starter-kit
2-
![CI/CD](https://github.com/poly-glot/vanilla-front-end-starter/workflows/CI/CD/badge.svg)
3-
[![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)
4-
[![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)
5-
[![Cypress.io Dashboard](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://dashboard.cypress.io/projects/8joug9/runs)
6-
[![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)
7-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/poly-glot/vanilla-front-end-starter)
1+
# tensorflowjs-remove-background
2+
![CI/CD](https://github.com/poly-glot/tensorflowjs-remove-background/workflows/CI/CD/badge.svg)
3+
[![codecov](https://codecov.io/gh/poly-glot/tensorflowjs-remove-background/branch/master/graph/badge.svg)](https://codecov.io/gh/poly-glot/tensorflowjs-remove-background)
4+
[![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)
5+
[![Cypress.io Dashboard](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://dashboard.cypress.io/projects/jp2thc/runs)
6+
[![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)
7+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/poly-glot/tensorflowjs-remove-background)
88

9-
A vanilla front-end starter kit with tools to support code quality, accessibility, unit testing, end to end testing,
10-
continuous integration setup and feature branch testing.
11-
12-
## Who it is for
13-
Suitable for responsive sites or simple applications in a fast pace delivery environment with
14-
shared nothing front-end architecture using vanilla js. However, code should be isolated & independent where possible to allow us to
15-
take benefits of previous projects and experience.
16-
17-
## List of tools
18-
- Code Quality: Eslint, Stylelint & Deepscan
19-
- Unit Testing: Jest + Enzyme
20-
- End to End testing: Cypress.io + Percy.io
21-
- CI: Github Actions
9+
Remove Background from picture using WebAssembly & TensorFlow.js
2210

2311
# Getting Started
2412
```
2513
npm install
2614
npm start
2715
```
2816

29-
## Adding a new Feature
30-
- Familiarise yourself with Gitflow and checkout a feature branch from master e.g. feature/awesome-feature.
31-
- Keep your feature branch upto date with master.
32-
- Use <a href="https://www.conventionalcommits.org/">Conventional Commits spec</a> e.g. (fix/feat/refactor/refactor!) | Component | Task ID - Small Description
33-
3417
## Manual Review Guidelines
3518
<table width="100%">
3619
<tr>
@@ -55,9 +38,6 @@ npm start
5538
</tr>
5639
</table>
5740

58-
# Estimation Guide for Static Projects
59-
(TODO)
60-
6141
# Local Development
6242

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

7757
### Docker
7858
```
79-
docker build -t vanilla-front-end-starter .
80-
docker run -it --rm -p 5000:5000 vanilla-front-end-starter
59+
docker build -t tensorflowjs-remove-background .
60+
docker run -it --rm -p 5000:5000 tensorflowjs-remove-background
8161
```
8262

8363
# Browser Support
8464
2 most recent versions of Chrome, Firefox, Safari & MS Edge.
85-
86-
# Todo
87-
- Feature : CI/CD - Add Docker preview.
88-
- Feature : CI/CD - Add automatic release after every two weeks.
89-
90-
# Github Secrets
91-
- ZEIT_TOKEN
92-
- NOW_ORG_ID
93-
- NOW_PROJECT_ID_STATIC
94-
- PERCY_TOKEN
95-
- CYPRESS_RECORD_KEY
96-
- CODECOV_TOKEN
97-
98-
# Non functional Requirements

cypress.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"defaultCommandTimeout": 60000,
3-
"projectId": "8joug9"
3+
"projectId": "jp2thc"
44
}

0 commit comments

Comments
 (0)