Sruta

श्रुता ( Sh-r-uu-t-ah )

Knowledge derived from instruction and reasoning

Table of Contents

• Features
• Prerequisites
• Getting Started
  • Installation
  • Configuration
  • Running the Application
• API Documentation
• Live Demo
• Dependencies
• Dev Dependencies
• License

Features

• User CRUD operations (Create, Read, Update, Delete)
• User registration and login with JWT authentication
• MongoDB integration for data storage
• API documentation with Swagger UI
• CORS configuration for cross-origin requests

Prerequisites

• Node.js v20.x
• MongoDB instance (local or remote)
• npm (Node Package Manager)

Getting Started

Installation

1. Clone the repository:

   git clone https://github.com/untangled-enigma/sruta-node.git
   cd sruta-node

2. Install dependencies:

   yarn install

Configuration

The application can be configured through the config.ts file in the root directory. Modify the configuration according to your needs:

• APP: Configuration related to the application, such as port, host, environment, logger, and JWT secret.
• DB: Database configuration, including MongoDB URI, host, port, and database name.

Running the Application

• Start the application in development mode:

  yarn run dev

• Build and run the application in production mode:

  yarn run build
  yarn start

API Documentation

API documentation is available using Swagger UI. Once the application is running, you can access the documentation at:

• http://localhost:3000/docs

Dependencies

• @fastify/cors
• @fastify/jwt
• @fastify/swagger
• @fastify/swagger-ui
• @hapi/boom
• bcryptjs
• dotenv
• fastify
• mongoose
• zod
• zod-to-json-schema

Dev Dependencies

• @types/bcryptjs
• @types/mongoose
• @types/node
• nodemon
• rimraf
• ts-node
• typescript

License

This project is licensed under the MIT License. See the LICENSE file for details.

Feel free to use the code, and if you do, please give me credit.