My Commands

Platform built with JavaScript & TypeScript & HTML5 & CCS3 & template-web-dotenv tools. Link: https://mycommands.es

Screenshot: Page main

Screenshot: Info about a command

Screenshot: Login page

Screenshot: Home page

Screenshot: Categories page

Screenshot: Commands page

Table of contents

• Table of contents
• About
• Installation
• Diagram UML
• Documentation Swagger v0.0.1
• Structure of project
• Updates
• Licence

About

Web page with different kind of commands such as data bases, servers, S.O. and much more.

Installation

Each folder regards to part of project, inside you will find variables of environment with .env.example as example, you can decide between .env.development.local or .env.production.local

• To execute with Docker, you must have Docker installed beforehand

    docker-compose build --no-cache && docker compose up -d

• Inside web application [webApp folder]

    # Install libraries
    npm install
    # Run application
    npm start

• Inside web page [webPage folder]

    # In this case, you must create a file *.env.development.local* or *.env.production.local*. Be careful, if you are going to execute with Docker, copy this file directly
   
    # Install libraries in container
    npm install
    # Run application
    npm start

• Inside mongo database [mongoDb folder]

    # Open the MongoDB shell and execute
    mongorestore backup_db  

Diagram UML

Documentation Swagger v0.0.1

Docs with Swagger

Structure of project

├── mongoDb                             # files to charge in MongoDB shell
├── webApp                              # web application built with React
├── webPage                             # web page built with Webpack and my template *template-web-dotenv*
├── webServer                           # Server built with Express
├── docker-compose.yml                  # Docker compose's file
└── README.md                           # project’s info

Updates

Current version 0.0.4 05-10-2024.
Each six months it tries to update all project with npm-check-updates library.

Licence

MIT License