README.md

🖥️ Projexa

Dashboard to organize and manage the team and the projects of our enterprise.

With the aim of creating efficient management and centralized data collection, access to leaders and other members of the junior company, Projexa offers an environment for the construction and continuous evolution of a web system, open-source and, mainly, promoted by developers CodeX Jr. internals. The application has a register of members, projects and links, available for viewing by the entire company, as well as management over each one, according to the authorization level of each user.

🚀 Starting

These instructions will allow you to get a copy of the project running on your local machine for development and testing purposes.

📋 Prerequisites

To run the Backend system, you will need to have Node JS installed.

You can do this accessing this link.

🔧 Installation

To install, you will need to clone the project, install the dependencies, create a .env file in the project root and add the necessary variables.

First, to clone the project, run:

git clone https://github.com/codexjr-dev/dashboard-codex-web.git

At the project root, install the dependencies by running:

npm install

Also in the project root, add a ".env" file and insert the following variables:

VITE_API_BASE_URL_DEV=<The URL that will be used to run the application (for example, you can use "http://localhost:4444" to run locally)>

Perhaps dependencies such as dotenv and vite, informs you that it needs to be installed globally (on your machine).

To do so, just listen to the following commands:

node i -g <dependence>

⚙️ Configuring Scripts

Before running, you may need to configure the scripts according to your Operating System.

Change the package.json according to your need:

Linux

"scripts": {
   "dev": "VUE_ENV=dev vite",
   "postinstall": "npm run build",
   "start": "VUE_ENV=prod node server.js",
   "build": "vite build",
   "preview": "vite preview --port 5050",
   "test:unit": "vitest --environment jsdom",
   "test:e2e": "start-server-and-test preview http://127.0.0.1:5050/ 'cypress open'",
   "test:e2e:ci": "start-server-and-test preview http://127.0.0.1:5050/ 'cypress run'",
   "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"
}

Windows

"scripts": {
   "dev": "SET VUE_ENV=dev && vite",
   "postinstall": "npm run build",
   "start": "SET VUE_ENV=prod && node server.js",
   "build": "vite build",
   "preview": "vite preview --port 5050",
   "test:unit": "vitest --environment jsdom",
   "test:e2e": "start-server-and-test preview http://127.0.0.1:5050/ 'cypress open'",
   "test:e2e:ci": "start-server-and-test preview http://127.0.0.1:5050/ 'cypress run'",
   "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"
}

---

✅ Running the System

Execute in production environment:

npm start

Execute in developer environment:

npm run dev

Execute tests, creating a temporary Data Base:

npm run test

🛠️ Built with

The main technologies used were:

• Vue - The JavaScript framework used
• npm - Dependency Manager
• Axios - JavaScript library
• PugJs - Template engine for JavaScript

🖇️ Collaboration

Please, read a COLLAB.md for details about our code of conduct and the process for submitting requests to us.

📌 Versions

• 1.0.0 - Completion of Course Work - Lucas Anthony.
• 1.2.1 - Visual identity improvements, correction in confirm password, logoff button added, input hiding in "Enter Password" fields and new roles to "Add User" page..
• 1.2.2 - console.log removed, role verifications updates, access to members and new roles to user..
• 1.2.3 - Bug Fixes, System Improvements and Visual Improvements..
• 1.2.4 - Two new buttons for create and preview project news, and invalid email format notification added.

✒️ Authors

@lucasanthony Initial Work

@ManoMax Continuation of Work

• Lucas Anthony - Initial Work - @lucasanthony
• Gabriel Max - Subsequent Project Leader - @ManoMax

You can also see the list of all contributors who participated in this project.

@anaritamed Developer	@FLuiz22 Developer	@maahog Developer	@matheusvictoor Developer
@danieleolivs UI Design	@carlos-lucenag UI Design

📄 License

This project is under license GNU General Public License v3.0 (GNU GPLv3) - see the file LICENSE.md for details.

---

⌨️ with ❤️ by CodeX Jr. 😊