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.

Read endpoints.md. for more API information.

🚀 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-api.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:

BD_PROD=<developer database link (MongoDB Atlas)>
BD_DEV=<production database link (MongoDB Atlas)>

PORT=<port on which you want to run the API. Ex: 4444>

SALT_ROUNDS=<integer of your choice>

JWT_SECRET=<jwt password>

Perhaps dependencies such as cors, dotenv, express, jsonwebtoken and/or mongoose inform you that they need 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": {
   "start": "NODE_ENV=prod node src/server.js",
   "test": "NODE_ENV=test mocha ./test/integration/*.test.js --timeout 10000 --exit",
   "dev": "NODE_ENV=dev nodemon src/server.js",
   "debug": "NODE_ENV=dev nodemon --inspect src/server.js"
}

Windows

"scripts": {
   "start": "set NODE_ENV=prod node && src/server.js",
   "test": "set NODE_ENV=test && mocha ./test/integration/*.test.js --timeout 10000 --exit",
   "dev": "set NODE_ENV=dev && nodemon src/server.js",
   "debug": "set NODE_ENV=dev nodemon && --inspect src/server.js"
}

---

✅ 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

🛠️ Construído com

The main technologies used were:

• express - The API used
• npm - Dependency Manager
• mongoose - Mongodb object modeling

🖇️ 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 - User Model Updates and role of user format changed.
• 1.2.2 - nodeenv configs, member access, role and email verifications and new roles.
• 1.2.3 - Bug Fixes and System Improvements.
• 1.2.4 - News of Project routes, email format validation and new structure to README.md.

✒️ 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. 😊