Skip to content

Latest commit

 

History

History
186 lines (135 loc) · 5.81 KB

README.md

File metadata and controls

186 lines (135 loc) · 5.81 KB

LinkedIn


Logo

NetDex Backend

This project serves as the back end for the NetDex application. It consists of an Express server that interacts with a Mongo database to provide the CRUD functionality for the application. The NetDex application provides the end user a way to organize their professional network in a simplistic and easy to understand interface. Think of your favorite professional social media platform. Now remove the social media portion of it. This is a tool for the user to maintain contact with their network without all the frills that come with being on a social media platform.

"Contacts, without the contact."

Link to NetDex frontend

Explore the docs »

View Demo: Get all contacts · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contact
  5. Acknowledgments

About The Project

Built With

  • Node
  • Express
  • MongoDB

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Ensure you have the latest version of npm installed.

npm install npm@latest -g

Ensure you have version 18.15.0 of node installed through NVM.

nvm install 18.15.0

Ensure you have the latest version of yarn installed.

npm install -g yarn

Ensure you have the latest versions of the following installed:

Installation

  1. Clone the repo 
    git clone https://github.khoury.northeastern.edu/NEU-CS5610-SU23/KevinHeleodoro-backend.git
  2. Install NPM packages 
    yarn install

Running locally

  1. Start the server 
    yarn dev

(back to top)

Roadmap

Release 1

  • User Routes:
    • Create a User
    • Get a User
    • Update a User
  • Contact Routes:
    • Create a Contact
    • Get a Contact
    • Get all Contacts for a User
    • Update a Contact
    • Add a Note to a Contact
    • Delete a Contact

Release 3

  • Error handling in get user info route for users that are not in the system.
    • Flawed logic within controllers where headers were being set multiple times within a sequence. Fixed the issue by explicitly declaring if..else conditions.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Kevin Heleodoro - @Golden_Sun_Kev - [email protected]

Project Link: https://github.khoury.northeastern.edu/NEU-CS5610-SU23/NetDex-backend

(back to top)

Acknowledgments

(back to top)