Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 1.74 KB

README.md

File metadata and controls

80 lines (57 loc) · 1.74 KB
Raw

React Logo

Gateways Management System (GMS) Frontend

The GMS frontend is a web application built with React, TypeScript, and Vite. It allows users to interact with the GMS backend API to manage gateways and their associated peripheral devices.

The application is currently temporarily deployed at https://gateways-backend-production.up.railway.app/ until March 1st.

Getting Started

Prerequisites

To run the GMS frontend, you'll need the following installed on your system:

  • Node.js (version 16 or higher)

Installation

  1. Clone the repository from GitHub:
https://github.com/jorgelhd94/gateways-frontend.git
  1. Install the dependencies:
yarn install
  1. Configure the environment variables:
  • Clone the file .env.template and rename the copy to .env
  1. Edit the environment variables defined in .env
  • This is the api backend url
VITE_SERVER_URL=http://localhost:3000/api/v1
  1. Start the server in development mode:
yarn dev
  1. Open the application in your web browser
http://localhost:5173/

Tests

To run the tests for the GMS frontend, use the following command:

yarn test

Deployment

  1. Run the following command:
yarn build
  1. Copy all the files located inside the /dist folder generated by the step one.
  2. And follow the deployment instructions in the: GMS Backend Repository.

Built With

  • React JS
  • Typescript
  • React Router
  • Redux
  • Vitest

License

This project is licensed under the MIT License.