https://github.com/ckay-9/k9-forums

FOS Forum Software
https://github.com/ckay-9/k9-forums

chat forums fun nestjs nextjs nodejs postgres utility web

Last synced: about 2 months ago
JSON representation

FOS Forum Software

• Host: GitHub
• URL: https://github.com/ckay-9/k9-forums
• Owner: CKAY-9
• License: agpl-3.0
• Created: 2023-07-30T23:44:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-23T17:58:46.000Z (about 1 year ago)
• Last Synced: 2023-10-23T18:41:13.900Z (about 1 year ago)
• Topics: chat, forums, fun, nestjs, nextjs, nodejs, postgres, utility, web
• Language: TypeScript
• Homepage:
• Size: 2.8 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# K9 Forums

![AGPL License](https://img.shields.io/badge/License-AGPL_V3.0-blue)

![Language](https://img.shields.io/badge/Language-TypeScript-red)



    


        

        

    

    


        

        

    

    


        

        

    

    


        

        

    

    


        

    



## About

K9 Forums is a free and open-source forum software built with NestJS and NextJS, using TypeScript. K9 Forums is meant to be a simple solution to forums while offering ease-of-use and configurability.

## Credits

- Thank you to uiwjs for react-markdown preview and editor

## Installation

This project is WIP and not finished. Run at your own risk.

*Docker support is being worked on*

```bash

# Clone the project

git clone https://github.com/CKAY-9/k9-forums.git

### Backend setup ###

cd backend

npm install

# env setup

export DATABASE_URL=postgres://my_postgres_login

# running

npm run build

npm run start

### Frontend setup ###

cd frontend

npm install

# env setup

export NEXT_PUBLIC_API_URL=http://localhost:3001

export NEXT_PUBLIC_CDN_URL=http://localhost:5000

# running

npm run build

npm run start

### CDN setup ###

cd cdn

# python setup

py -3 -m venv .venv

.venv\Scripts\activate

pip install flask

pip install markupsafe

pip install werkzeug

pip install -U flask-cors

# running

flask --app main run

### WebSocket Server ###

cd ws-server

npm install

# env setup

export INTERNAL_API_URL=http://localhost:3001

export INTERNAL_CDN_URL=http://localhost:5000

# running

npm run build

npm run start

```