https://github.com/isur/isomorphic-react-app
Isomorphic React App.
https://github.com/isur/isomorphic-react-app
Last synced: about 1 year ago
JSON representation
Isomorphic React App.
- Host: GitHub
- URL: https://github.com/isur/isomorphic-react-app
- Owner: Isur
- Created: 2020-03-01T21:14:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T04:44:27.000Z (over 3 years ago)
- Last Synced: 2023-03-04T12:48:45.129Z (over 3 years ago)
- Language: TypeScript
- Size: 1010 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Starter
Isomoprhic React Application.
## Table of contents
- [Getting Started](#getting-started)
- [Running the tests](#running-the-tests)
- [Deployment](#deployment)
- [Built with](#built-with)
- [Authors](#authors)
- [License](#license)
## Getting Started:
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
To start this project you need `npm`, `node`, `postgresql` database and `linux` system.
Recommended: `docker`, `docker-compose`
### Installing
To install packages:
`npm install`
To run development envinronment use
`npm run dev`
Webpack.ts will build and launch application.
## Running the tests
### Unit tests
Test and generate coverage report:
`npm run test`
Test, watch and generate coverage report:
`npm run test:watch`
### Linter
Run linter and if possible, fix:
`npm run lint`
Linter with max warning set to 0:
`npm run linter-no-warnings`
## Deployment:
If you want to deploy your app on live system use:
`npm run build`
It will check your code and build the application.
To start it use:
`npm run start`
You can also build docker image:
`docker build -t [name] .`
## Built with
- [Webpack](https://webpack.js.org/)
- [Node.js](https://nodejs.org/en/)
- [Express](https://www.npmjs.com/package/express)
- [React](https://reactjs.org/)
- [Babel](https://babeljs.io/)
- [Typescript](https://www.typescriptlang.org/index.html)
- [SASS](https://sass-lang.com/)
- [Eslint](https://eslint.org/)
- [Prisma](https://www.prisma.io/)
## Authors
- **Artur Bednarczyk** - *Initial work* - [Isur](https://github.com/isur)
## License
This project is licensed under the MIT License