Skip to content

Latest commit

 

History

History
178 lines (129 loc) · 6.98 KB

README.md

File metadata and controls

178 lines (129 loc) · 6.98 KB
Raw

Contributors Forks Stargazers Issues


Logo

Coffee Contacts

This is a simple app to help engineers save contacts for the folks they have met networking.
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

As engineers, we all know the importance of networking: whether it be for job searches, the exchange of ideas, or just making new friends in the industry.

There are many different ways out there to keep track of contacts for the people you meet. The focus of this app is to concentrate on a specific demoghraphic -- the people you meet when networking.

Coffee Contacts is a one-stop shop for storing contact information for the people you meet. Users can add new contacts, update existing ones, and even delete contacts.

(back to top)

Built With

(back to top)

Getting Started

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

Installation

  1. Clone the repo 
    git clone https://github.com/tpritchard843/put-in-the-netWORK.git
  2. Install NPM packages 
    npm install
  3. Update DB_STRING in config/database to connect to your own MongoDB cluster
  4. Open a terminal instance in your editor
  5. Run the following command and check http://localhost:3001 
    npm run dev

(back to top)

Roadmap

  • Add user profiles with sign-up and login features
  • Add authorization
  • Implement caching to boost performance
  • Add session storage to DB

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

(back to top)

Lessons Learned

  • Utilized express routing methods in the server to try and build a modular and scalable backend. Through this we learned how to handle incoming HTTP requests from the client and route them as necessary to our MongoDB database and then respond accordingly with some data.

  • We learned how to create and connect to a MongoDB database using the MongoClient. This allows us to store data in JSON-like documents that are easy to handle on the client and the server.

  • We also learned about the event loop, and how to utilize promises in our CRUD API to prevent blocking in our application. This creates a better user experience.

(back to top)