Velar Starter Project

Welcome to the Velar Starter Project! This repository serves as a boilerplate for building applications using the Velar framework, a powerful and flexible Node.js framework designed to simplify the development of scalable web applications.

Features

• Modular Architecture: Easily manage and scale your application with a modular structure.
• Express Integration: Built on top of Express.js for robust and flexible routing.
• Environment Configuration: Seamlessly handle different environments (development, production, etc.).
• Error Handling: Comprehensive error handling and logging.
• Testing Setup: Pre-configured testing environment with popular tools.

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

• Node.js (version 16.x or later)
• npm (version 6.x or later) or yarn

Installation

1. Clone the repository:

   git clone https://github.com/velarjs/starter.git
   cd starter

2. Install dependencies:

   npm install

3. Set up environment variables:

   Rename the .env.example file to .env and update the variables as needed.

   mv .env.example .env

Running the Application

To start the development server:

npm run dev

Building for Production

To build the application for production:

npm run build

Project Structure

Here's an overview of the project's structure:

├── app/
│   ├── app.controller.ts
│   ├── app.dto.ts
│   ├── app.model.ts
│   ├── app.module.ts
│   ├── app.repository.ts
│   ├── app.service.ts
│   └── app.spec.ts
├── public/
│   └── index.html
├── shared/
│   └── utils.ts
├── .gitignore
├── .env.example
├── package.json
├── server.ts
├── settings.ts
├── README.md
└── tsconfig.json

Contributing

We welcome contributions to improve this project! If you have any suggestions or issues, please open an issue or submit a pull request.

License

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

Acknowledgements

Thank you for using Velar Starter! We hope it helps you build amazing applications.

Happy coding! 🚀