Skip to content

Commit fa86d59

Browse files
committed
Update Readme
1 parent 2be1ed5 commit fa86d59

File tree

3 files changed

+30
-36
lines changed

3 files changed

+30
-36
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
.env
1+
.env
2+
*.swp
3+
.DS_Store

README.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
1-
# Semaphore demo CI/CD pipeline using JavaScript (ReactJS/NodeJS)
1+
# Semaphore demo CI/CD pipeline using JavaScript (Node.js, TypeScript, Nest.js, React)
22

3-
Example application and CI/CD pipeline showing how to run a JavaScript project which consists of ReactJS client and NodeJS server on Semaphore 2.0.
3+
Example application and CI/CD pipeline showing how to run a JavaScript project
4+
on Semaphore 2.0. Project consists of a Node.js server based on Nest.js, and a
5+
React client. Code is written in TypeScript.
6+
7+
## CI/CD on Semaphore
8+
9+
Fork this repository and use it to [create a
10+
project](https://docs.semaphoreci.com/article/63-your-first-project).
11+
12+
The CI pipeline will look like this:
13+
14+
![CI pipeline on Semaphore](images/ci-pipeline.png)
15+
16+
The example pipeline contains 4 blocks:
17+
18+
- Install Dependencies
19+
- installs and caches all npm dependencies
20+
- Run Lint
21+
- Runs tslint to check project files codestyle
22+
- Run Unit Tests
23+
- Runs Unit Tests
24+
- Run E2E Tests
25+
- Runs E2E tests through cypress on client.
26+
- Runs E2E tests through jest on server.
427

528
## Local project setup
629

7-
This project will require postgresql database. If you don't have one you can launch docker container with db for this app.
30+
This project requires a PostgreSQL database. If you don't have one you can
31+
launch a Docker container to have one.
832

933
### Configuration
1034

@@ -32,38 +56,6 @@ Steps described in server [README](src/server/README.md)
3256

3357
Steps described in client [README](src/client/README.md)
3458

35-
## CI/CD on Semaphore
36-
37-
Fork this repository and use it to [create a
38-
project](https://docs.semaphoreci.com/article/63-your-first-project):
39-
40-
```
41-
curl https://storage.googleapis.com/sem-cli-releases/get.sh | bash
42-
sem connect <semaphore-organization-link> <semaphore-id> // found in Semaphore Dashboard
43-
cd <project directory>
44-
sem init
45-
```
46-
47-
After that, push to the repository to trigger a workflow on Semaphore.
48-
49-
The CI pipeline will look like this:
50-
51-
![CI pipeline on Semaphore](images/ci-pipeline.png)
52-
53-
The example pipeline contains 5 blocks:
54-
55-
- Install Dependencies
56-
- installs and caches all npm dependencies
57-
- Run Lint
58-
- Runs tslint to check project files codestyle
59-
- Run Unit Tests
60-
- Runs Unit Tests
61-
- Run E2E Tests
62-
- Runs E2E tests through cypress on client.
63-
- Runs E2E tests through jest on server.
64-
- Run project Build
65-
- Runs tsc to build projects and prepare them for deploy
66-
6759
## License
6860

6961
Copyright (c) 2019 Rendered Text

images/ci-pipeline.png

50.7 KB
Loading

0 commit comments

Comments
 (0)