Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remix-run/starter-express
Starter project for using Remix with Express
https://github.com/remix-run/starter-express
Last synced: about 1 month ago
JSON representation
Starter project for using Remix with Express
- Host: GitHub
- URL: https://github.com/remix-run/starter-express
- Owner: remix-run
- Archived: true
- Created: 2020-09-28T03:19:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-04-29T23:25:18.000Z (about 3 years ago)
- Last Synced: 2024-04-14T03:00:27.544Z (2 months ago)
- Language: TypeScript
- Homepage: https://remix.run
- Size: 413 KB
- Stars: 111
- Watchers: 8
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-remix - Starter Express - Archived. (Starter)
- awesome-remix - Starter Express - Archived. (Starter)
- awesome-stars - remix-run/starter-express - Starter project for using Remix with Express (TypeScript)
README
## Please Don't Use
> Please use `npm init remix` instead of this starter repo to create a new Remix app.
> This repository was archived on April 29, 2021.
# Remix Starter for Express
Welcome to Remix!
This is a starter repo for using [Remix](https://remix.run) with [Express](http://expressjs.com/).
## Development
After cloning the repo, rename `.npmrc.example` to `.npmrc` and insert the license key you get from [logging in to your dashboard at remix.run](https://remix.run).
> Note: if this is a public repo, you'll probably want to move the line with your key into `~/.npmrc` to keep it private.
Then, install all dependencies using `npm`:
```sh
$ npm install
```
Your `@remix-run/*` dependencies will come from the Remix package registry.
Once everything is installed, start the app in development mode with the following command:
```sh
$ npm run dev
```
This will run a few processes concurrently that will dynamically rebuild as your source files change. To see your changes, refresh the browser.
> Note: Hot module reloading is coming soon, which will allow you to see your changes without refreshing.
## Production
To run the app in production mode, you'll need to build it first.
```sh
$ npm run build
$ npm start
```
This will start a single HTTP server process that will serve the app from the files generated in the build step.
## Documentation
Detailed documentation for Remix [is available at remix.run](https://remix.run/dashboard/docs).
## Project Structure
All application source code is found in the `app` directory. This includes your application entry points for both server rendering (see `app/entry.server.tsx`) and the browser (see `app/entry.client.tsx`), as well as your root component and routes (see `app/root.tsx` and `app/routes`).
Everything in the `public` directory is served by `express.static`.
## Don't want TypeScript?
The [`no-typescript` branch](https://github.com/remix-run/starter-express/tree/no-typescript) is a version of this same starter template that uses plain JavaScript instead of TypeScript for all code in `app`.