Chatr Web Service

Express.js web service for the Chatr app

📃 Table of Contents:

• About The App
• Screenshots
• Technologies
• Setup
• Approach
• Status
• Credits

📕 About The App

📸 Screenshots

💻 Technologies

🛠️ Setup

Installation

To install this project, follow the steps below:

1. Clone the repository from GitHub:

git clone https://github.com/krobison10/chatr-web-service

2. Navigate to the project directory:

cd chatr-web-service

3. Install the dependencies using npm:

npm install

API Documentation

To generate the API documentation, run the following command in the terminal:

apidoc -i routes/ -o apidoc/ -d

🤓 Approach

Project Structure

Tech Decisions

📈 Status

The Android client for Chatr is currently complete and no further work is expected to occur.

Current backlog:

Credits

List of contriubutors:

• Kyler Robison
• Jasper Newkirk
• Leyla Ahmed
• Betelhem Bada