ISPP-G1-Talent

Index

1. Quick start
2. MongoDB installation

Quick start

Before you can start, make sure you have MongoDB installed and have started the port as specified in the MongoDB installation section.

1. Start the database port

• Open a terminal in the directory: C:\Program Files\MongoDB\Server\4.4\bin
  • You can do this by navigating to the directory and typing "cmd" in the address bar, then pressing enter
• To execute the command to expose the MongoDB port, you can use the following command in the terminal:

  mongod

  Make sure to keep the terminal open at all times while using the system, as it needs to be running to keep the MongoDB port exposed.
• To view the database, follow these steps:
  • Open MongoDB Compass.
  • Enter the URI mongodb://localhost:27017.
  • Click on the "Connect" button.

2. Download and install Node.js: visit the official Node.js website at https://nodejs.org (NODE VERSION MUST BE 20.11.1)
3. Clone this repository

git clone https://github.com/JaviFdez7/ISPP-G1-Talent.git

4. Install the dependencies (from the root directory)

npm install

5. Create .env file from .env.example file

GH_TOKEN=<YOUR-GH-TOKEN>

6. Run the server Terminal 1 (frontend)

npm run install-frontend
npm run start-frontend

Terminal 2 (backend)

npm run install-backend
npm run start-backend

Creating backend modules

To create a module open a terminal it the root of the repoitory. Then use create-backend-module MODULE_NAME VERSION

warning	MODULE_NAME must be written in snake-case
info	VERSION is an optional argument (default is v1)

For example:

create-backend-module team-creator

create-backend-module team-creator v2

MongoDB installation

1. Navigate to the C drive directory on your computer and create a folder named 'data'.

2. Access the 'data' folder and create a subfolder named 'db'.

3. Download MongoDB Compass on your computer from the following link: download link

4. During the MongoDB installation, uncheck the option to install MongoDB as a service.