https://github.com/krzysiou/comm-api

API for comm website. It handles all the server-side job of the website.
https://github.com/krzysiou/comm-api

api expressjs

Last synced: about 7 hours ago
JSON representation

API for comm website. It handles all the server-side job of the website.

• Host: GitHub
• URL: https://github.com/krzysiou/comm-api
• Owner: krzysiou
• Created: 2024-03-23T00:42:12.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-04-27T10:54:21.000Z (7 months ago)
• Last Synced: 2024-04-28T10:28:46.185Z (7 months ago)
• Topics: api, expressjs
• Language: TypeScript
• Homepage: https://comm-api.adaptable.app/
• Size: 108 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# comm-api

![Website](https://img.shields.io/website?url=https%3A%2F%2Fcomm-api.adaptable.app%2Fstatus)

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

```

2. Install dependencies:

```

npm install

```

3. Configure environment variables:

Copy the `.env.example` file to `.env` and fill in the necessary configuration details, including database connection information and secret keys.

5. Start the server:

```

npm run dev

```

or

```

npm run build && npm run start

```

6. The API server will be running locally and accessible at `http://localhost:3100`.