Git Product home page Git Product logo

comm-api's Introduction

comm-api

Website

This repository contains the backend API for the Community Collaboration Platform. It serves as the backend server responsible for handling data storage, authentication, and communication with the frontend client.

Features

Authentication

  • Provides secure authentication mechanisms for users.
  • Supports user registration, login, and logout functionality.
  • Implements token-based authentication for secure communication between client and server.

Data Storage

  • Manages storage and retrieval of user data, messages, and user profiles.

RESTful API

  • Exposes a RESTful API for interaction with the frontend client.
  • Supports CRUD operations for managing user accounts, messages, and user profiles.
  • Implements endpoint authentication and authorization to control access to resources.

Technologies

  • TypeScript
  • Express.js
  • Websockets
  • JWT

Installation

To run the Community Collaboration Platform API locally, follow these steps:

  1. Clone the repository:
git clone https://github.com/krzysiou/comm-api.git
  1. Install dependencies:
npm install
  1. Configure environment variables: Copy the .env.example file to .env and fill in the necessary configuration details, including database connection information and secret keys.

  2. Start the server:

npm run dev

or

npm run build && npm run start
  1. The API server will be running locally and accessible at http://localhost:3100.

comm-api's People

Contributors

krzysiou avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.