My Remote Job

Welcome to the server side!

Here you will find some infromations about the web api and the backend.

Docs

You can access the documentation page from route: /api/v1/docs

Into the stack:

This project use some popular libraries:

Mongoose - Used for manage data with MongoDB
Express - Used for build the server
Cheerio - Used for create the scrapers
Swagger - Used to document the endpoints of this web API

How to run:

Before runs make sure you have Node Js installed on your machine

Clone this repository and navigate to the server folder
Then run yarn or npm i
Setup your connection string to a MongoDB server
1. Open the file mongoose.ts in src/data/database
2. Change the value of connectionString with your connection string
  For example:
```
//mongoose.ts

const connectionString = 'YOUR CONNECTION STRING HERE';
```
Finally you can run yarn dev:debug or npm dev:debug to run in debug mode or just yarn start or npm start to start the application
Optional: Change the app port
1. For default this app will runs at port 3333 but you can change editting the value of the variable port in the app.ts file in src/app.ts
  For example:
```
//app.ts

const port = 3333; // Note that this value only acepts positive integer numbers
```