Git Product home page Git Product logo

create-nextws's Introduction

create-nextws


Scaffolding NextJS + NextWS + Strapi -- Dockerized


Feature of the app stack

  1. Web: A Next.js 14 project utilizing the new app router and server actions/components.
  2. API: A Strapi 4.22 project that serves as the backend.
  3. WS: A NextWS route for NextJS internal client-server communication.

usage

Initialize

npx create-nextws@latest

Quickstart

Enter a name, and confirm automatic mode

image

image

Custom Configuration

Enter a name, and deny automatic mode

You can then set any environment variable including PORTs and also all docker compose service names.

If secret keys are ommited, they will be generated.

careful: generation is random. so if you delete the project and rerun the create command, you will get new generated keys! (you have to backup your keys on your own if you need them later)

image

Features of the create-nextws

  1. Command Line Interface: This project provides a command line interface for easy interaction. It supports arguments like --help, --docs, and --version.

  2. Docker Integration: The project checks if Docker is running on the system and can operate in a 'lite' mode if Docker is not available.

  3. Project Scaffolding: It prompts the user for project details and scaffolds a new project based on the user's input.

  4. Customization: The user can customize various aspects of the project such as whether to auto-generate .env files, and whether to customize compose service names.

  5. Environment Configuration: The project supports the generation and copying of .env files based on user preferences.

  6. Docker Compose Configuration: If Docker is available, the project can configure Docker Compose and start Docker containers.

  7. Documentation: After the project is set up, it displays documentation to the user.


creator creator

create-nextws's People

Contributors

yeonv avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.