Setup Guide

Follow these steps to set up a new project using the `nc-api-boilerplate-cli` template.

Step 1: Clone the Repository

Clone the `nc-api-boilerplate-cli` repository to your local machine:

git clone [email protected]:NuveiConnect/nc-api-boilerplate-cli.git

Step 2: Go to the Project Folder

Navigate to the cloned project directory:

cd nc-api-boilerplate-cli

Step 3: Install Dependencies

Run the following command to install the required dependencies:

npm install

Step 4: Link the Package

Link the package globally using `npm link`:

npm link

Step 5: Create a New Project

Run the following command to create a new project:

nc-create-new

Step 6: Choose a Template

The CLI will prompt you to choose a template. By default, we have one template called `api`. Press Enter to choose the `api` template.

Step 7: Name the Project

Next, it will ask you to provide a name for your new project. For example, enter `onboarding`:

Enter project name: onboarding

After pressing Enter, the project will be created, and dependencies will be installed.

Note: If you see an error related to Husky during installation, you can safely ignore it.

Step 8: Go to the New Project Directory

Navigate to the folder of the newly created project:

cd onboarding

Step 9: Run the Project with Docker

Run the following command to start the project using Docker Compose:

docker compose up

Troubleshooting:

• If you get an error, it might be due to the service already running. You can check for any existing containers or services using `docker ps` and stop them as necessary.
• After running the above command, your project will be live at `http://localhost:3501`.

Step 10: Access the Project

Open your browser and go to `http://localhost:3501` to see the project running!

Congratulations, your project is now up and running!