mmartinrm97 / api-sepulveda-notus-frontend

SIS Sepulveda (Frontend)

Welcome to the API documentation for SIS Sepulveda (Frontend), a comprehensive inventory control software designed for use in public institutions.

Table of Contents

• Introduction
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Features
• Usage
• License

Introduction

SIS Sepulveda Frontend is the user interface for the inventory control system designed to enhance user interactions and streamline inventory management processes in public institutions.

Getting Started

Prerequisites

Before you begin, ensure you have the following software installed:

• Node.js (v14 or later)
• npm (or yarn)

Installation

To get started, follow these steps:

1. Clone the SIS Sepulveda Frontend repository:

git clone https://github.com/mmartinrm97/frontend-sepulveda-notus.git

2. Navigate to the project directory:

cd sis-sepulveda-frontend

3. Install dependencies using npm:

npm install

Configuration

Create a copy of the .env.example file and rename it to .env:

cp .env.example .env

Update the .env file with any necessary configuration settings, such as API endpoints or environment variables.

Features

• User-friendly interface for managing inventory items
• Intuitive order management system
• Responsive design for seamless usage on different devices

Usage

Start the development server:

npm run dev

This will compile and serve the frontend application. You can access the application in your browser at http://localhost:3000.

License

This software is licensed under the Apache License 2.0.

For more information about SIS Sepulveda or to report any issues, please contact our support team at [email protected]