Skip to content

projects-assignments/backend-mudapp-happy-mongo

Repository files navigation

HappyMongo

Introduction

Welcome to the repository of the web application designed to streamline the world of moving and parcel transportation. This initiative aims to connect people with the need for goods transportation to carriers with vehicles suitable for those needs, drawing inspiration from the successful UBER model.

This app has been developed as an assignment for the Factoria F5 Bootcamp, January-February 2024.

Nest Logo

Congratulations team! So far, we have made significant progress in developing the web application and have successfully established the database. In this phase, we will focus on the backend development of the application.

Team Creator

Technical Requirements

To ensure the quality and efficiency of our application, we have established the following technical requirements:

  1. Linting:

    • Linting has been implemented to maintain consistent and high-quality code.
  2. Testing:

    • Unit testing and integration testing have been conducted for all application endpoints.
  3. Documentation:

    • API documentation has been created using OpenAPI (Swagger) to facilitate understanding and usage.
  4. Deployment in Production:

    • The application has been successfully deployed in a production environment.

Deliverables

The required deliverables are detailed below:

  1. GitHub Repository:

  2. Readme:

  3. Logical Database Model:

    • The logical database model is attached in a file.
  4. Database Dump File:

    • A database dump file is provided to facilitate environment replication.
  5. Installation Instructions:

    • Detailed instructions on how to install and run the application.
  6. Presentation

Index

  1. Introduction
  2. Technical Requirements
  3. Pedagogical Modality
  4. Deliverables
  5. Index

Repository Contents

  • /backend: Contains the source code of the backend of the application.
  • /docs: API documentation generated with Swagger.
  • /database: Contains the logical database model and the dump file.
  • /presentation: Files related to the presentation.

Technologies Used

TypeScript MongoDB MongoDB MongoDB NestJS Swagger Visual Studio Code GitHub Jest Jira Slack Postman Discord Render Firebase ESLint TOR Mosquitto

Resource Links

Thank you for visiting our repository! We are excited to share the progress of our project. If you have any questions or suggestions, feel free to contact us. We hope you find our application useful!



Installation

$ pnpm add -g @nestjs/cli #optional
$ pnpm install
$ pnpm add @nestjs/mongoose mongoose
$ pnpm add @nestjs/jwt
$ pnpm add --save-dev @types/bcrypt
$ pnpm add --save-dev @types/passport-local

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

About

backend-mudapp-happy-mongo created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6