Code Monkey home page Code Monkey logo

lt-client's Introduction

lt-client project

Description

This project is the UI to show companies catalog

Table of Contents

Frontend

Installation

  • Install nvm in order to use different versions of node
# clone the repo
$ git https://github.com/joseceron/lt-client.git
 
# go into app's directory
$ cd lt-client
 
# use node version 16.14.0
$ nvm install 16.14.0
$ nvm use 16.14.0
 
# install app's dependencies
$ npm install

Quick Start

lt-client
├── .env         # environment variables file
├── src/            
└── package.json
...

Usage for development

# serve at localhost:8000 with automatic restart when saving
$ npm run dev
 
# Compiles and minifies for production
$ npm run build
 

Docker

# 1. clone image
$ docker pull dockerjctest1/lt-vue-dev
# OR 1. build the image by your own
$ docker build -t dockerHubUser/projectName
 
# run 
$ docker run --name lt-frontend --rm -d -p 5173:5173 -it dockerjctest1/lt-vue-dev
# stop docker
$ docker stop lt-frontend

Keep in mind that this component points to a server so that component needs to be deployed fist.

What is included

Within the download you will find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You will see something like this:

admiosflixweb
├── dist/                    # static files
│   └── index.html     # html template
├── conf/                  # configuration for hosting
│   └── nginx.conf     # nginx confir
│
├── src/                    # project root
│   ├── api/      		  # backend requests
│   ├── assets/         # images, icons, styles, etc.
│   ├── components/  # common components , footer, sidebar, etc.
│   ├── constants/    # centralized constants
│   ├── containers/   # The container of components
│   ├── models/        # model interfaces
│   ├── pages/         # main pages views
│   └── router/         # paths of the application
│   └── store/           # Vuex State files
│   ├── views/          # application views
│   ├── App.vue
│   └── main.ts         # main entrance file
│
└── .dockerignore.  		# Docker ignore file
└── Dockerfile.        		  # Docker commands for development
└── Dockerfile.prod.        # Docker commands for production
└── package.json            # libraries and scripts
└── README.md            # project description file

Server

  • Go to this repository to execute the server project
  • Have in mind that the server project is required in order to run the frontend component. Because the frontend project sends the petitions to it

Features and technologies

  • bootstrap: front end css library
  • firebase auth: allows multiplatform access
  • vuex: for state management
  • docker: containerization
  • nginx: web server
  • jspdf: PDF generator
  • axios: backend requests
  • typescript

Table of Contents

[TOCM]

[TOC]

lt-client's People

Contributors

joseceron avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.