BACKEND GLOBANT BROKEN OFFICE

Explore the docs »
Frontend Repository
Report bug · Request feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. API Documentation
4. Roadmap
5. Contributing
6. Contact

About The Proyect

Mobile first application that allows reporting problems and damaged items in the offices or homes of globers using geolocation, machine learning and other technologies to make the experience as simple as possible.

(back to top)

Built With

• NodeJS
• Nodemon
• Express
• Sequelize
• Postgres
• Voleyball
• Bcrypt
• JWT
• Handlebars
• Nodemailer
• FS
• DotEnv
• Mocha
• Chai
• Axios
• Cloudinary
• DataDog

(back to top)

Getting Started

Currently the database is entirely local. Therefore, you will need to follow these instructions to build the backend project.

Prerequisites

You must meet the following pre-requisites to be able to use this project

• DB: Create the DB using psql

  createdb brokenoffice

Installation

1. Clone the repo

   git clone https://github.com/Merssith/BrokenOffice-Back.git

2. Install NPM packages

   npm install

3. Seed database

   npm run seed

4. Generate the .env file, using as a base the example found in this repository
5. Run the server

   npm run server

(back to top)

API Documentation

Detailed documentation of all API methods can be found HERE. You can also download the complete Postman collection.

(back to top)

Roadmap

• Features for all users
  • Sign up
  • Login/Logout
  • Session persistence
  • Incident creation
  • Incident history
  • User profile
• Admin features
  • Assigned incidents
  • Resolve incidents or change status
  • Start chat
• Super Admin features
  • See all incidents
  • See all users
  • Manage users
• Additional features
  • Geolocation for all users and incidents
  • Machine Learning for incidents
  • Auto assignment of incidents to the closest administrator
  • Chat
  • Backend monitoring
  • Email service
  • PWA
  • DarkMode

(back to top)

Contributing

Contributions from the Dev community help us learn, be inspired, and create new things! All contributions are welcome!

If you have any suggestions to improve our project, please fork the repository and create a pull request. Or You can open an issue.

Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/MyFeature)
3. Commit your Changes (git commit -m 'Add MyFeature')
4. Push to the Branch (git push origin feature/MyFeature)
5. Open a Pull Request

(back to top)

Contact

• Mercedes Salcedo » Email - LinkedIn
• Patricio Imbrogno » Email - LinkedIn
• Rodrigo Escalera » Email - LinkedIn
• Juan Manuel Arias » Email - LinkedIn
• Leandro Echezuri » Email - LinkedIn

Project Link: https://github.com/Merssith/BrokenOffice-Back

(back to top)