Nimship Admin (Nuxt)

Project Overview

Nimship Admin is a Nuxt-based administrative interface for managing driver information and related operations. This project aims to provide a user-friendly, efficient, and scalable solution for driver management.

Getting Started

Prerequisites

• Node.js (v14 or later)
• pnpm (v6 or later)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/nimship-admin-nuxt.git
   cd nimship-admin-nuxt

2. Install dependencies:

   pnpm install

Running the Development Server

To start the development server:

pnpm dev

The application will be available at http://localhost:3000.

Building for Production

To build the application for production:

pnpm build

Running Tests

To run the test suite:

pnpm test

Documentation

For detailed information about the project, please refer to the following documentation:

• Developer Onboarding Guide
• Project Structure
• API Documentation
• UI Components
• Composables
• Mobile Responsiveness Guide
• Package Compatibility Guide
• Puppeteer Setup Guide

For information about specific layouts, check the layouts documentation.

Contributing

Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

License

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

Development Notes

• The builds folder is excluded from version control to prevent build failures. Please ensure it is listed in your local .gitignore file.