Skip to main content

Getting Started with gs project

Simplifying Project Setup with create-gs-project​

Welcome to create-gs-project, your go-to CLI tool for streamlining project initialization with both client and server components. This guide will walk you through the seamless process of leveraging this tool to kickstart your next project.

Getting Started​

Pre-requisite​

You should have typescript installed globally in your system. Please check if typescript is present: tsc -v, if it is not there, please install npm install -g typescript

To initialize your new project effortlessly, execute the following command in your terminal:

npx create-gs-project@latest init

Upon running this command, you'll be prompted to enter a name for your project:

? Enter the Project name: ›

After providing the project name, you'll be presented with options to choose the type of project you desire: client, server, or both.

? Choose the project types: ›
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    a: Toggle all
    enter/return: Complete answer
◯   server
◯   client

Select your preferred project type(s), and create-gs-project will handle the rest. It will establish a new directory with the specified name (e.g., my-project) and initialize all essential files and dependencies. Inside this directory, you'll discover a client directory for the client project and a server directory for the server project.

Congratulations! You've successfully initialized your project with create-gs-project. Now, dive into development by injecting your code and tailoring the project to suit your requirements. Let your creativity soar!