Skip to content
full-fledged full-stack framework for building web apps
TypeScript JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
config
src
translations
.editorconfig
.env.tmpl
.flowconfig
.gitignore
.npmrc
.prettierignore
LICENSE
Procfile
README.md
ava.config.js
babel-register.js
babel.config.js
gulpfile.babel.js
package.json
renovate.json
server.ts
tsconfig.json
tslint.editor.json
tslint.json
webpack.js

README.md

web-onefx-boilerplate

CircleCI

Getting Started

OneFx is a full-stack framework for building web apps. Here are the features you'll find in Onefx.js:

  • server side rendering and universal rendering with react and redux
  • ES2017, JSX, TypeScript support out of the box
  • server-side development via Koa.js

Create a project

git clone git@github.com:puncsky/web-onefx-boilerplate.git my-awesome-project

Run your project

This is intended for *nix users. If you use Windows, go to Run on Windows. Let's first prepare the environment.

cd my-awesome-project

nvm use 10.15.0
npm install

# prepare environment variable
cp ./.env.tmpl ./.env

Development mode

To run your project in development mode, run:

npm run watch

The development site will be available at http://localhost:5000.

Production Mode

It's sometimes useful to run a project in production mode, for example, to check bundle size or to debug a production-only issue. To run your project in production mode locally, run:

npm run build-production
NODE_ENV=production npm run start

NPM scripts

  • npm run test: test the whole project and generate a test coverage
  • npm run ava ./path/to/test-file.js: run a specific test file
  • npm run build: build source code from src to dist
  • npm run lint: run the linter
  • npm run kill: kill the node server occupying the port 5000.
You can’t perform that action at this time.