node-start-ridaura v24.1.21

Node.js start v24.1.21

Copyright (c) 2024 Sergio Ridaura.
https://sergio-ridaura.vercel.app - sergio.ridaura@outlook.com

Description

My start theme to develop with Node.js and TypeScript.

New project

To use this repository as a template in your projects, clone the project.

git clone https://github.com/sergio-ridaura/node-start.git

Adapt the README.md, package.json, docker-compose.yml, .env and LICENSE files to your needs.

Manage your project tasks in the todo folder.

Start the container with Docker Compose.

docker-compose up -d

Access the Node.js container.

docker exec -it node_node-start

Add project dependencies.

npm install

Run the test.

npm run test

Application

For application development, use the src/index.ts file and components from the src/components folder.

For the development of the application.

npm run dev

Create application, CLI and the package to use in Npm.

npm run build

Run the application.

npm run start

CLI

For developing a CLI application, use the src/cli.ts file.

npm run dev:start

Create application, CLI and the package to use in Npm.

npm run build

To run the built application.

npm run start:cli

To install the local CLI application on your computer.

npm install -g .

To install the npm CLI application on your computer.

npm install -g node_node-start

Run installed CLI application

node-start-ridaura

Npm

To develop an Npm package, add the modules in the src/package.ts file.

Create application, CLI and the package to use in Npm.

npm run build

Publish the package to Npm.

npm addUser
npm publish

Using modules

Install the module in your project. For example:

npm i node-start-ridaura

Example of module use:

import { helloWorld } from "node-start-ridaura";

console.log(helloWorld("in Node.js"));

Author

Sergio Ridaura

Full stack developer in TypeScript with Astro.js, Next.js, React.js, Node.js and MongoDB.
Quick development of high-performance applications and websites.

MIT License

Copyright (c) 2024 Sergio Ridaura.
https://sergio-ridaura.vercel.app - sergio.ridaura@outlook.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.