JaviFdez7 / ISPP-G1-Talent

6 stars 3 forks source link

ISPP-G1-Talent

Codacy Badge Bluejay Dashboard

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.

  3. Start the database port

  1. Download and install Node.js: visit the official Node.js website at https://nodejs.org (NODE VERSION MUST BE 20.11.1)

  2. Clone this repository

    git clone https://github.com/JaviFdez7/ISPP-G1-Talent.git
  3. Install the dependencies (from the root directory)

    npm install
  4. Create .env file from .env.example file

    GH_TOKEN=<YOUR-GH-TOKEN>
  5. 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'.

image

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

image

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

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

image