Naively Programmable Module

    create-nitro-app

    0.7.0 • Public • Published

    Create Nitro App

    The easiest way to create a React app with server-side rendering thanks to Next.js with the modules below :

    If you run into any issues or have feedback, please file an issue

    Overview

    yarn global add create-nitro-app
     
    create-nitro-app my-app
    cd my-app/
    yarn dev

    Open http://localhost:3000 to view your running app. When you're ready for production, run npm run build then npm run start.

    Create Nitro App running in terminal Create Nitro App running in terminal

    Start Coding Now

    You don't need to install or setup Webpack or Babel. They come packaged with nitro, so you can just start coding.

    After running create-nitro-app, you're good to go!

    Getting Started

    Installation

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

    You don't need to use Node as your primary backend. The Node installation is only required for Create Nitro App and running the Nitro.js server in development/production.

    Creating an App

    To create a new app, run:

    create-nitro-app my-app
    cd my-app
    

    It will create a directory called my-app inside the current folder.
    Inside that directory, it will generate the initial project structure and install necessary dependencies:

    Routing in Nitro.js is based on the file system, so ./pages/index.js maps to the / route and ./pages/about.js would map to /about.

    The ./static directory maps to /static in the nitro server, so you can put all your other static resources like images or compiled CSS in there.

    Out of the box, we get:

    • Automatic transpilation and bundling (with webpack and babel)
    • Hot code reloading
    • Server rendering and indexing of ./pages
    • Static file serving. ./static/ is mapped to /static/

    Once the installation is finished, you can run some commands in your project:

    npm run dev or yarn dev

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

    The page will reload if you make edits.
    You will also see any errors in the console.

    npm run build or yarn build

    Builds the app for production to the .nitro folder.
    It correctly bundles React in production mode and optimizes the build for the best performance.

    npm run start or yarn start

    Starts the application in production mode. The application should be compiled with `npm run build` first.

    Now you're ready to code & deploy your app!

    Acknowledgements

    We are grateful to the authors of existing related projects for their ideas as inspiration:

    Looking for alternatives? Here are some other project starter kits:

    Questions? Feedback? Please let us know

    License (MIT)

    WWWWWW||WWWWWW
     W W W||W W W
          ||
        ( OO )__________
         /  |           \
        /o o|    MIT     \
        \___/||_||__||_|| *
             || ||  || ||
            _||_|| _||_||
           (__|__|(__|__|
    

    Copyright (c) 2017-present Atto-Byte, Inc. william@atto-byte.com

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i create-nitro-app

    DownloadsWeekly Downloads

    0

    Version

    0.7.0

    License

    MIT

    Unpacked Size

    66.5 kB

    Total Files

    29

    Last publish

    Collaborators

    • williamluke4