This is a repository for a small app demo to prove my skills at web development

This project is using Mongo DB in a docker container.

1. Install docker & docker-compose https://docs.docker.com/compose/install/

2. Up container with docker-compose

docker-compose up -d

The docker-compose.yml file contains some environment variables to initialize the database with authentication.

There is a file called mongo-init.js that is copied into the container that creates a not admin user. This new user can only read and write into database.

Nest JS is a progressive Node.js framework for building efficient, reliable and scalable server-side applications. https://nestjs.com/.

Nest JS can help US to build amazing server applications with concepts of OOP. I can say that this framework is like working with Angular 2+ in backend side.

https://nodejs.org/es/

You can also build a docker container with this Node JS version already installed

Every dependecy this project user can be located in package.json and can be installed with the following command:

cd backend
npm install

Copy all variables from .env.example file and then create a new file called .env

touch .env

This file will contain the values for each variable acording to your own environment

Your .env file should have exactly the following content to work in your localhost for this demo.

DB_HOST=localhost
DB_NAME=dbdemo
DB_PORT=27017
DB_USERNAME=demoUser
DB_PASSWORD=d3m0p4ssw0rd

cd backend
npm start

npm run start:dev

This project is configured to generate documentation with Swagger where you can see all the relevant information of each API endpoint. Just open your browser and go to the next URL (Assuming the server is already running).

http://localhost:3000/api

Frontend is built with React.js and it uses the following dependecies too:

1. react-bootstrap
2. react-router-dom
3. axios

Same as the backend dependencies

cd frontend
npm install

Create a file called .env.local

touch .env.local

Your .env.local file should have exactly the following content to work in your localhost for this demo.

PORT=4200
SASS_PATH:src

cd frontend
npm start

Your browser will be opened at http://localhost:4200