https://github.com/mtguerson/mycontacts-api
📒 This repo contains an Express.js backend for a contacts app, using PostgreSQL for data storage and Docker for easy deployment. Managed with Yarn for dependency control.
https://github.com/mtguerson/mycontacts-api
express postgresql
Last synced: 2 months ago
JSON representation
📒 This repo contains an Express.js backend for a contacts app, using PostgreSQL for data storage and Docker for easy deployment. Managed with Yarn for dependency control.
- Host: GitHub
- URL: https://github.com/mtguerson/mycontacts-api
- Owner: mtguerson
- Created: 2024-02-02T20:58:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T13:31:46.000Z (over 2 years ago)
- Last Synced: 2025-02-23T00:45:45.342Z (over 1 year ago)
- Topics: express, postgresql
- Language: JavaScript
- Homepage:
- Size: 4.57 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contacts Application Backend
## Short Description
This repository contains the source code for the backend of a contacts application. Developed using Express.js, this RESTful server offers a robust API for CRUD (Create, Read, Update, Delete) operations on a contacts database. PostgreSQL is utilized as the database management system to securely and efficiently store contact information. Moreover, the project is configured to run within Docker containers, simplifying deployment and execution across different environments.
## Features
- **Express.js**: A fast, unopinionated, minimalist web framework for Node.js.
- **PostgreSQL**: A powerful, open-source object-relational database system.
- **Docker**: Container support ensuring ease of deployment and environment consistency.
- **Yarn**: Used for package management, offering reliable and secure dependency management.
## Getting Started
To start using this backend, please follow the setup and installation instructions in this README.md. Ensure Docker is installed on your machine to streamline the development and deployment process.
## Installation
1. Clone the repository:
git clone
2. Navigate to the project directory:
cd
3. Install dependencies using Yarn:
yarn install
4. Start the application using Docker:
docker-compose up --build