Skip to content

coffeebid-capstone/coffeBid-API

Repository files navigation

Backend Repository

Welcome to the Backend Repository of coffeBid! This repository contains the backend code and resources for coffeBid

About coffeBid-API

CoffeBid-API is a repository contains the backend code and resources for coffeBid.

Technologies Used

  • Node.js: Node.js is an open-source, cross-platform, JavaScript runtime environment. Node.js lets developers use JavaScript to write command line tools and for server-side scripting. The ability to run JavaScript code on the server is often used to generate dynamic web page content before the page is sent to the user's web browser. Consequently, Node.js is often used for real-time web applications.

  • Flask: Flask is a micro web framework written in Python. It is classified as a microframework because it does not require particular tools or libraries. It has no database abstraction layer, form validation, or any other components where pre-existing third-party libraries provide common functions. However, Flask supports extensions that can add application features as if they were implemented in Flask itself. Extensions exist for object-relational mappers, form validation, upload handling, various open authentication technologies and several common framework related tool

Installation and Setup Node.js

To set up the backend locally, please follow these steps:

  1. Clone the repository:

    git clone -b master https://github.com/coffeebid-capstone/coffeBid-API.git
    
  2. Navigate to the project directory:

    cd coffeBid-API
    
  3. Install the dependencies

    npm install
    
  4. Start the backend server

    npm start
    
    
    

Installation and Setup Flask

To set up the backend locally, please follow these steps:

  1. Clone the repository:

    git clone -b ml-api https://github.com/coffeebid-capstone/coffeBid-API.git
    
  2. Navigate to the project directory:

    cd coffeBid-API
    
  3. Install the dependencies

    pip install
    
  4. Start the backend server

    pyhton app.py
    
    

API Documentation

The API documentation for CoffeeBid can be found in the API Documentation file. It provides detailed information about the available endpoints, request/response formats, and authentication requirements.

Releases

No releases published

Packages

No packages published