https://github.com/tjmelo/tmx-venus

A simple project CRUD elements list for add, edit, and exclude interative elements.
https://github.com/tjmelo/tmx-venus

babel html javascript sass

Last synced: 3 months ago
JSON representation

A simple project CRUD elements list for add, edit, and exclude interative elements.

• Host: GitHub
• URL: https://github.com/tjmelo/tmx-venus
• Owner: tjmelo
• License: mit
• Created: 2021-01-05T19:23:19.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-31T04:04:30.000Z (6 months ago)
• Last Synced: 2024-09-09T18:53:23.793Z (5 months ago)
• Topics: babel, html, javascript, sass
• Language: JavaScript
• Homepage: https://tmx-shoplist.netlify.app/
• Size: 2.33 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![project](https://img.shields.io/badge/project-TMX%20Venus-blue)

# TMX Venus

![Size](https://img.shields.io/github/repo-size/tjmelo/tmx-venus) ![Version](https://img.shields.io/github/package-json/v/tjmelo/tmx-venus) ![Release](https://img.shields.io/github/v/release/tjmelo/tmx-venus) ![Last Commit](https://img.shields.io/github/last-commit/tjmelo/tmx-venus/main)

![Passing](https://img.shields.io/github/actions/workflow/status/tjmelo/tmx-venus/checkout-ci.yml)

[![Netlify Status](https://api.netlify.com/api/v1/badges/ec8a4c81-bee8-4c94-87f0-f9606385df67/deploy-status)](https://app.netlify.com/sites/tmx-shoplist/deploys)

## Table of content

- [About app](#about-app)

- [Preview Screens](#preview-screens)

- [Project details](#project-details)

  - [CSS](#css)

  - [Build](#build)

  - [Simple Develop Process](#simple-develop-process)

  - [Docker Develop Process](#docker-develop-process)

  - [NPM Package](#npm-package)

# About app

### Simple CRUD Shop List

This project is a simple **CRUD** elements list.

Add an element to the list

- Edit element at list

- Exclude element at list

# Preview Screens

![Preview](/src/images/shopping-list.png)

![Preview](/src/images/shopping-list2.png)

### Project Details

This app uses:

- [x] HTML

- [x] JavaScript

- [ ] Typescript

- [ ] Redux

- [x] Babel

- [x] Sass

- [x] Webpack

- [x] Docker

## CSS

To compile CSS in the development process:

```sh

npm run css

```

## Build

To generate build:

```sh

npm run build

```

## Simple Develop Process

[![Tasks TMX Venus runner](https://github.com/tjmelo/tmx-venus/actions/workflows/checkout-ci.yml/badge.svg)](https://github.com/tjmelo/tmx-venus/actions/workflows/checkout-ci.yml)

Download the project

Clone or fork this repository

```sh

git clone https://github.com/tjmelo/tmx-venus.git

cd tmx-venus

git checkout -b develop

npm install && npm start

```

## Docker Develop Process

[![image-docker-ci](https://github.com/tjmelo/tmx-venus/actions/workflows/ghpckg-image-ci.yml/badge.svg)](https://github.com/tjmelo/tmx-venus/actions/workflows/ghpckg-image-ci.yml)

```sh

git clone https://github.com/tjmelo/tmx-venus.git

cd tmx-venus

docker compose up -d

```

Install from the command line

```

docker pull ghcr.io/tjmelo/tmx-venus:latest

```

or image in **Docker Hub** for optional download

```

docker pull tmwd/tmx-venus

```

Open the app on a browser http://localhost:9000

## NPM Package

[![publish-to-github-packages](https://github.com/tjmelo/tmx-venus/actions/workflows/ghpckg-npm-ci.yml/badge.svg)](https://github.com/tjmelo/tmx-venus/actions/workflows/ghpckg-npm-ci.yml)

[![publish-to-npm](https://github.com/tjmelo/tmx-venus/actions/workflows/npm-registry.yml/badge.svg)](https://github.com/tjmelo/tmx-venus/actions/workflows/npm-registry.yml)

For installation by npm package :

> Aggregated micro frontend

```bash

npm install @tjmelo/tmx-venus@latest

```

Have a code fun :fire: