Skip to content

README.md

Latest commit

 

History

History
91 lines (54 loc) · 5.04 KB

README.md

File metadata and controls

91 lines (54 loc) · 5.04 KB

📄 Table of Contents

This README consists of the following parts, listed below:

👨‍💻 Developer

Full Name User GitHub
Ricardo Salvatorelli rsca7213 https://github.com/rsca7213

💻 Teck Stack

Logo Type Name Download Link Version
Language TypeScript https://www.typescriptlang.org/download 5.3.2
Framework Nest.JS https://docs.nestjs.com/#installation 10.0.0
Dependency Manager Node Package Manager https://www.npmjs.com/get-npm 10.4.0
Runtime Environment Node.JS https://nodejs.org/en/download/ 18.17.0
Database Manager SQLite with TypeORM npm install sqlite3 3
Framework Angular https://angular.io/guide/setup-local 17.2.0
CSS Library Bootstrap https://getbootstrap.com/docs/5.2/getting-started/introduction/ 5.3.2
Icon Library Material Design Icons https://pictogrammers.com/docs/guides/iconify/ 7.4.47

⚠️ Required Installs

These installations are mandatory and the application will not work without them, Follow the order listed here

  • Node.JS and Node Package Manager

    Version 18.17.0 (Node.JS) y 10.4.0 (Node Package Manager)

    The technologies are necessary because they allow the execution of JavaScript files without the need for a browser and allow you to manage the dependencies of projects written in JavaScript.

    Steps for installation:

    • Access the Node.JS download website https://nodejs.org/en/download/

    • When you are on the website, you must select the installer for the operating system version you are using. Note: This installer contains Node.JS and NPM.

    • Once the installer download is complete, run it and proceed to install the technologies. Note: It is very important to add the variables to the system PATH if you are on Windows.

  • TypeScript

    Version 5.3.2

    This language is required to interpret and translate files with the extension ".ts" to files ".js" that are understandable by the execution environment.

    Steps for installation:

    • To install this language, you must open any command prompt and run the following command:

      npm install -g typescript

🔧 App Install

To install the application, you must follow the following steps:

  • Clone the repository to your device.

  • Then, run the following command inside the folder to get the stack of frameworks and libraries on which the application infrastructure depends:

    cd backend && npm install

    cd frontend && npm install

🔌 Running the App

To run the application, you simply need to write one of the following two commands in a command prompt located in the application folder:

  • Run the application from Bash Script:

    ./deploy.sh