https://github.com/trustworktech/create-react-ssr-app
Set up a modern react app with server side rendering by running one command.
https://github.com/trustworktech/create-react-ssr-app
build-tools react zero-configuration
Last synced: 20 days ago
JSON representation
Set up a modern react app with server side rendering by running one command.
- Host: GitHub
- URL: https://github.com/trustworktech/create-react-ssr-app
- Owner: trustworktech
- License: mit
- Archived: true
- Created: 2019-02-13T02:19:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-23T19:02:01.000Z (over 6 years ago)
- Last Synced: 2025-10-30T09:45:53.998Z (8 months ago)
- Topics: build-tools, react, zero-configuration
- Language: JavaScript
- Homepage: https://create-react-ssr-app.dev
- Size: 1.94 MB
- Stars: 91
- Watchers: 8
- Forks: 29
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-github-projects - create-react-ssr-app - Set up a modern react app with server side rendering by running one command. ⭐91 `JavaScript` (📦 Legacy & Inactive Projects)
README
**ATTENTION: This repository is no longer under active development and has been archived. You can still use current releases of this library but not further releases will be made as of now. Please contact the previous maintainer [max](https://twitter.com/max_parelius) if you have questions or are interested in taking over. Thanks.**
# Create React SSR App
Create React apps with server side rendering and no build configuration. Inspired by the famous [create-react-app](https://facebook.github.io/create-react-app/), Create React SSR App does the same thing for React apps that require server side rendering.
- [Creating an App](#creating-an-app) – How to create a new app.
- [User Guide](https://create-react-ssr-app.dev/) – How to develop apps bootstrapped with Create React SSR App.
Create React SSR App works on macOS, Windows, and Linux.
If something doesn’t work, please [file an issue](https://github.com/trustworktech/create-react-ssr-app/issues/new).
If you have questions or need help, please ask in our [Spectrum](https://spectrum.chat/create-react-ssr-app) community.
## Quick Overview
```sh
npx create-react-ssr-app my-app
cd my-app
npm start
```
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
### Get Started Immediately
You **don’t** need to install or configure tools like Webpack or Babel.
They are preconfigured and hidden so that you can focus on the code.
Just create a project, and you’re good to go.
## Creating an App
**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to easily switch Node versions between different projects.
To create a new app, you may choose one of the following methods:
### npx
```sh
npx create-react-ssr-app my-app
```
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
### npm
```sh
npm init react-ssr-app my-app
```
_`npm init ` is available in npm 6+_
### Yarn
```sh
yarn create react-ssr-app my-app
```
_`yarn create` is available in Yarn 0.25+_
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
```
my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── public
│ ├── app.html
│ ├── favicon.ico
│ └── manifest.json
└── src
├── client
| ├── index.css
│ └── index.js
├── server
| ├── middleware
| | ├── html.js
| | └── render.js
│ └── index.js
├── App.css
├── App.js
├── App.test.js
├── index.js
└── logo.svg
```
No configuration or complicated folder structures, just the files you need to build your app.
Once the installation is done, you can open your project folder:
```sh
cd my-app
```
Inside the newly created project, you can run some built-in commands:
### `npm start` or `yarn start`
Runs the app in development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.
### `npm test` or `yarn test`
Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.
[Read more about testing.](https://create-react-ssr-app.dev/docs/running-tests)
### `npm run build` or `yarn build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed.
## User Guide
You can find detailed instructions on using Create React SSR App and many tips in [its documentation](https://create-react-ssr-app.dev/).
## How to Update to New Versions?
Please refer to the [User Guide](https://create-react-ssr-app.dev/docs/updating-to-new-releases) for this and other information.
## Contributing
We'd love to have your helping hand on `create-react-ssr-app`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
## License
Create React SSR App is open source software [licensed as MIT](https://github.com/trustworktech/create-react-ssr-app/blob/master/LICENSE).