Update readme file and apps

Author: loginwashere

LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019 Rendered Text
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,25 +1,37 @@
-# Semaphore demo CI/CD pipeline using PHP Laravel
+# Semaphore demo CI/CD pipeline using JavaScript (ReactJS/NodeJS)
 
-Example application and CI/CD pipeline showing how to run a PHP Laravel project
-on Semaphore 2.0.
+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.
 
 ## Local project setup
 
-To setup the project locally, your local environment needs to meet common
-Laravel development requirements, as per [Laravel
-Documentation](https://laravel.com/docs/5.7#server-requirements).
-We recommend setting up using Vagrant and Homestead, as it is a turn key
-solution supported on all major operating systems.
+This project will require postgresql database. If you don't have one you can launch docker container with db for this app.
 
-Once the local environment is set up, you can run the following commands:
+### Configuration
 
+```bash
+$ cp .sample.env .env
 ```
-cp .env.example .env // and enter your DB details in the newly created .env
-composer install
-php artisan key:generate
-php artisan migrate
+
+### Launch db
+
+```bash
+$ docker-compose up
+```
+
+### Stop db
+
+```bash
+$ docker-compose down
 ```
 
+### Configure and launch server
+
+Steps described in server [README](src/server/README.md)
+
+### Configure and launch client
+
+Steps described in client [README](src/client/README.md)
+
 ## CI/CD on Semaphore
 
 Fork this repository and use it to [create a
@@ -36,25 +48,24 @@ After that, push to the repository to trigger a workflow on Semaphore.
 
 The CI pipeline will look like this:
 
-![CI pipeline on Semaphore](public/ci-pipeline.png)
+![CI pipeline on Semaphore](images/ci-pipeline.png)
 
 The example pipeline contains 6 blocks:
 
  - Install Dependencies
-    -  installs and caches all composer and npm dependencies
- - Run Code Analysis
-    - Runs PHP Mess Detector which as an example is installed as a composer dependency
-    - Runs PHP Code Sniffer which as an example is installed as a composer dependency
-    - Runs PHP Copy Detector which is called via cURL from the .phar package available online
+    -  installs and caches all npm dependencies
+ - Run Lint
+    - Runs tslint to check project files codestyle
  - Run Unit Tests
     - Runs PHPUnit Unit Tests
- - Run Browser Tests
-    - Runs browser tests through Laravel Dusk.
- - Run Security Tests
-    - Runs Sensiolabs security checker pulled in via cURL
+ - Run E2E Tests
+    - Runs E2E tests through cypress on client.
+    - Runs E2E tests through jest on server.
+ - Run project Build
+    - Runs tsc to build projects and prepare them for deploy
 
 ## License
 
 Copyright (c) 2019 Rendered Text
 
-Distributed under the MIT License. See the file LICENSE.md.
+Distributed under the MIT License. See the file [LICENSE.md](./LICENSE.md).

images/ci-pipeline.png

@@ -37,8 +37,36 @@ Instead, it will copy all the configuration files and the transitive dependencie
 
 You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
 
+### `npm run cypress:open`
+
+Opens cypress dashboard to manage e2e tests
+
+### `npm run start:ci`
+
+Start app con port 3030. Shortcut for ci e2e step
+
+### `npm run cypress:run`
+
+**Note: you need to start client app to use this command**
+
+Runs e2e tests.
+
+### `npm run test:e2e`
+
+Runs e2e tests. It also starts client app on default port `3030` before running tests using `start-server-and-test` package
+
+### `npm run lint`
+
+Check app code stype
+
 ## Learn More
 
 You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
 
 To learn React, check out the [React documentation](https://reactjs.org/).
+
+## License
+
+Copyright (c) 2019 Rendered Text
+
+Distributed under the MIT License. See the file [LICENSE.md](../../LICENSE.md) in repo root.

src/client/README.md

@@ -1,7 +1,7 @@
 {
-  "name": "client",
+  "name": "@semaphoreci/semaphore-demo-js-react-client",
   "version": "0.1.0",
-  "private": true,
+  "license": "MIT",
   "dependencies": {
     "@material-ui/core": "^3.9.2",
     "@material-ui/icons": "^3.0.2",

src/client/package-lock.json

@@ -1 +1 @@
-REACT_APP_API_BASE_URL=http://localhost:3001/v1/api
+REACT_APP_API_BASE_URL=http://localhost:3001/v1/api

src/client/package.json

@@ -1,39 +1,35 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
-</p>
-
-[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
-[travis-url]: https://travis-ci.org/nestjs/nest
-[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
-[linux-url]: https://travis-ci.org/nestjs/nest
-  
-  <p align="center">A progressive <a href="http://nodejs.org" target="blank">Node.js</a> framework for building efficient and scalable server-side applications, heavily inspired by <a href="https://angular.io" target="blank">Angular</a>.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/dm/@nestjs/core.svg" alt="NPM Downloads" /></a>
-<a href="https://travis-ci.org/nestjs/nest"><img src="https://api.travis-ci.org/nestjs/nest.svg?branch=master" alt="Travis" /></a>
-<a href="https://travis-ci.org/nestjs/nest"><img src="https://img.shields.io/travis/nestjs/nest/master.svg?label=linux" alt="Linux" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5" alt="Coverage" /></a>
-<a href="https://gitter.im/nestjs/nestjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge"><img src="https://badges.gitter.im/nestjs/nestjs.svg" alt="Gitter" /></a>
-<a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec"><img src="https://img.shields.io/badge/Donate-PayPal-dc3d53.svg"/></a>
-  <a href="https://twitter.com/nestframework"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
 ## Description
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+App is built using [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
 
 ## Installation
 
 ```bash
 $ npm install
 ```
 
+## Configuration
+
+These values should work on development environment without changes
+
+### Copy app config
+
+```bash
+$ cp sample.env .env
+```
+
+### Copy db config
+
+```bash
+$ cp ormconfig.sample.json ormconfig.json
+```
+
+### Run migrations
+
+```bash
+$ npm run migrate:up
+```
+
 ## Running the app
 
 ```bash
@@ -47,6 +43,14 @@ $ npm run start:dev
 $ npm run start:prod
 ```
 
+## Lint
+
+Check app code style
+
+```bash
+$ npm run lint
+```
+
 ## Test
 
 ```bash
@@ -60,16 +64,18 @@ $ npm run test:e2e
 $ npm run test:cov
 ```
 
-## Support
-
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+## Migrations
 
-## Stay in touch
+```bash
+# up migrations
+$ npm run migrate:up
 
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+# revert last migration
+$ npm run migrate:revert
+```
 
 ## License
 
-  Nest is [MIT licensed](LICENSE).
+Copyright (c) 2019 Rendered Text
+
+Distributed under the MIT License. See the file [LICENSE.md](../../LICENSE.md) in repo root.

src/client/sample.env

@@ -1,3 +1,5 @@
+PORT=3001
+URL_PREFIX=v1/api
 DATABASE_HOST=localhost
 DATABASE_USER=postgres
 DATABASE_PASSWORD=

src/server/README.md

@@ -1,3 +1,4 @@
+PORT=3001
 DATABASE_TYPE=postgres
 DATABASE_HOST=localhost
 DATABASE_USER=demouser

src/server/ci.env

@@ -1,7 +1,6 @@
 {
-  "name": "nest-typescript-starter",
+  "name": "@semaphoreci/semaphore-demo-js-react-server",
   "version": "1.0.0",
-  "description": "Nest TypeScript starter repository",
   "license": "MIT",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

src/server/development.env

@@ -1,3 +1,5 @@
+PORT=3001
+URL_PREFIX=v1/api
 DATABASE_HOST=localhost
 DATABASE_USER=demouser
 DATABASE_PASSWORD=qwerty

src/server/package-lock.json

@@ -1,14 +1,7 @@
 import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
-
 import { ApiModule } from './api/api.module';
-
-import * as dotenv from 'dotenv';
-import * as fs from 'fs';
-import * as path from 'path';
-import { AdvancedConsoleLogger } from 'typeorm';
-
-const config = dotenv.parse(fs.readFileSync(path.resolve(__dirname, '..', '.env')));
+import config from './config';
 
 @Module({
   imports: [

src/server/package.json

@@ -0,0 +1,7 @@
+import * as dotenv from 'dotenv';
+import * as fs from 'fs';
+import * as path from 'path';
+
+const config = dotenv.parse(fs.readFileSync(path.resolve(__dirname, '..', '..', '.env')));
+
+export default config;

src/server/sample.env

@@ -1,9 +1,10 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
+import config from './config';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule, { cors: true });
-  app.setGlobalPrefix('v1/api');
-  await app.listen(3001);
+  app.setGlobalPrefix(config.URL_PREFIX);
+  await app.listen(config.PORT);
 }
 bootstrap();

src/server/src/app.module.ts

@@ -3,6 +3,7 @@ import { Test } from '@nestjs/testing';
 import { AppModule } from './../src/app.module';
 import { INestApplication } from '@nestjs/common';
 import { UsersService } from '../src/api/users/users.service';
+import config from '../src/config';
 
 describe('AppController (e2e)', () => {
   const user = {
@@ -45,42 +46,42 @@ describe('AppController (e2e)', () => {
       .compile();
 
     app = moduleFixture.createNestApplication();
-    app.setGlobalPrefix('v1/api');
+    app.setGlobalPrefix(config.URL_PREFIX);
     await app.init();
   });
 
-  it('/v1/api/users (GET)', () => {
+  it(`/${config.URL_PREFIX}/users (GET)`, () => {
     return request(app.getHttpServer())
-      .get('/v1/api/users')
+      .get(`/${config.URL_PREFIX}/users`)
       .expect(200)
       .expect(JSON.stringify(result.findAll));
   });
 
-  it(`/v1/api/users/${user.id} (DELETE)`, () => {
+  it(`/${config.URL_PREFIX}/users/${user.id} (DELETE)`, () => {
     return request(app.getHttpServer())
-      .delete('/v1/api/users/1')
+      .delete(`/${config.URL_PREFIX}/users/${user.id}`)
       .expect(200)
       .expect(result.remove);
   });
 
-  it(`/v1/api/users/${user.id} (GET)`, () => {
+  it(`/${config.URL_PREFIX}/users/${user.id} (GET)`, () => {
     return request(app.getHttpServer())
-      .get('/v1/api/users/1')
+      .get(`/${config.URL_PREFIX}/users/${user.id}`)
       .expect(200)
       .expect(JSON.stringify(result.findOne));
   });
 
-  it(`/v1/api/users/${user.id} (PUT)`, () => {
+  it(`/${config.URL_PREFIX}/users/${user.id} (PUT)`, () => {
     return request(app.getHttpServer())
-      .put(`/v1/api/users/${user.id}`)
+      .put(`/${config.URL_PREFIX}/users/${user.id}`)
       .send(user)
       .expect(200)
       .expect(JSON.stringify(result.update));
   });
 
-  it('/v1/api/users (POST)', () => {
+  it(`/${config.URL_PREFIX}/users (POST)`, () => {
     return request(app.getHttpServer())
-      .post(`/v1/api/users`)
+      .post(`/${config.URL_PREFIX}/users`)
       .send(user)
       .expect(201)
       .expect(JSON.stringify(result.create));