Skip to content

Pingzehao/create-react-kotlin-app

Repository files navigation

Create React Kotlin App Build Status

JetBrains incubator project

Create React apps in Kotlin with no build configuration.

If something doesn’t work please file an issue.

Quick Overview

Install create-react-kotlin-app using npm:

npm install -g create-react-kotlin-app

Create a new project:

create-react-kotlin-app my-app

Run the project:

cd my-app/ npm start

Then open http://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle with npm run build.

npm start

Get Started Immediately

You don’t need to install or configure tools like webpack or Kotlin.
They are preconfigured and hidden so that you can focus on the code.

Just create a project, and you’re good to go.

Getting Started

Installation

Install it once globally:

npm install -g create-react-kotlin-app

You’ll need to have Node >= 6 on your machine. You can use nvm to easily switch Node versions between different projects.

This tool doesn’t assume a Node backend. The Node installation is only required for Create React Kotlin App itself.

Creating an App

To create a new app, run:

create-react-kotlin-app my-app cd my-app

It will create a directory called my-app inside the current folder.
The project will preconfigure the project for working with it in IntelliJ IDEA. If you don't want to create the .idea folder that is required for IntelliJ IDEA, add --no-idea option.
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/ favicon.ico index.html manifest.json src/ app/ App.css App.kt index/ index.css index.kt logo/ kotlin.svg Logo.css Logo.kt react.svg ticker/ Ticker.kt 

It's a simple app that shows the time that passed since the app was opened.
Once the installation is done, you can run some commands inside the project folder:

npm start or yarn start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will see the build errors and lint warnings in the console.

Build errors

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.
By default, it also includes a service worker so that your app loads from local cache on future visits.

Your app is ready to be deployed.

npm run gen-idea-libs or yarn gen-idea-libs

npm run get-types or yarn get-types

How to Update to New Versions?

Please refer to the User Guide for this and other information.

Philosophy

  • One Dependency: There is just one build dependency. It uses Webpack and other amazing projects, but provides a cohesive curated experience on top of them.

  • No Configuration Required: You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.

  • No Lock-In: You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.

Why Use This?

With create-react-kotlin-app you can quickly bootstrap a new application using Kotlin and React. Your environment will have everything you need to build a new Kotlin app:

  • Kotlin and React syntax support.
  • A dev server that automatically compiles your Kotlin code to JavaScript.
  • A build script to bundle JS, CSS, and images for production, with sourcemaps.

The feature set is intentionally limited. It doesn’t support advanced features such as server rendering or CSS modules. The tool is also non-configurable because it is hard to provide a cohesive experience and easy updates across a set of tools when the user can tweak anything.

Converting to a Custom Setup

If you’re a power user and you aren’t happy with the default configuration, you can “eject” from the tool and use it as a boilerplate generator.

Running npm run eject copies all the configuration files and the transitive dependencies (webpack, Kotlin Compiler, etc) right into your project so you have full control over them. Commands like npm start and npm run build will still work, but they will point to the copied scripts so you can tweak them. At this point, you’re on your own.

Note: this is a one-way operation. Once you eject, you can’t go back!

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Limitations

What’s Inside?

The tools used by Create React Kotlin App are subject to change. Currently it is a thin layer on top of other projects, such as:

All of them are transitive dependencies of the provided npm package.

Contributing

We'd love to have your helping hand on create-react-kotlin-app! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

Acknowledgements

This project is based on Facebook's Create React App. We thank its its authors for their work and inspiration.

About

Create React apps using Kotlin with no build configuration

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 71.7%
  • Shell 23.6%
  • Kotlin 2.3%
  • HTML 1.7%
  • CSS 0.7%