john-rice / tsed-example-react

Ts.ED - React

This project show you how you can create a project based on Ts.ED + React as client application. This example can be used to create project based on other popular client frameworks like React or Angular.

See Ts.ED project for more information.

Features

• React + Create React App
• TypeORM Included with sample @EntityRepository
• Lerna && Yarn workspaces - monorepo manager
• PM2 - node process manager
• Docker and Docker compose
• Travis CI

Requirement

Because this project use lerna and workspaces, you have to install yarn before build and run project.

npm install -g yarn

Checkout

This repository provide getting started project example for each Ts.ED version since v5.18.1.

git checkout -b https://github.com/tsedio/tsed-example-vue-js/tree/v5.18.1

To checkout another version just replace v5.18.1 by the desired version.

Install

Important! Ts.ED requires Node >= 8, Express >= 4 and TypeScript >= 3.

yarn install

Starting a new project

Replace all reference @project by your project name. @project key are referenced in theses files:

• package.json,
• client/package.json,
• server/package.json

Open Server.ts and modify the SQL Server Settings, if you are using some other detabase then please change the driver details and database details in the TYPEORM section. Pleaes make sure that the table Employee exists with the columns(id,empfname,emplname,createdDate,lastModifiedDate) as specified in the entities/Employee.ts

Run

yarn start

React UI in the Browser

Open http://localhost:3000 and you will see TOTAL USERS=<No of records in the employee table> in the server logs.

Contributing

You can make a PR directly on https://github.com/tsedio/ts-express-decorators repository.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

The MIT License (MIT)

Copyright (c) 2016 - 2019 Romain Lenzotti

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.