https://github.com/omgimalexis/up-n-down

https://github.com/omgimalexis/up-n-down

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/omgimalexis/up-n-down
• Owner: OmgImAlexis
• License: mit
• Created: 2021-12-26T08:18:18.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-15T16:47:31.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T07:53:41.035Z (about 1 month ago)
• Language: TypeScript
• Size: 2.74 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Up 'n' Down

Up 'n' Down is a link aggregation internet forum. Users write posts and nested comments. Users must follow other users in order to see their content.

Other features:

* REST API

* Public and Private Groups

* [Site Documentation](https://up-n-down.xyz/docs/site)

* [API Documentation](https://up-n-down.xyz/docs/api)

## Install

Install one of the [tagged releases](https://github.com/omgimalexis/up-n-down/releases), preferably the most recent.

Create a PostgreSQL 11+ database.

Install Redis. This is only for the session store. Redis 6+ should be used.

Make sure you have Node.js installed. 

Run `npm install` to download all the Node.js dependencies that are listed in `package.json`.

Set the following environment variables in a `.env` file.

* `PGHOST`: PostgreSQL host (usually `localhost`)

* `PGUSER`: PostgreSQL username

* `PGDATABASE`: PostgreSQL database name

* `PGPASSWORD`: PostgreSQL password

* `PGPORT`: PostgreSQL port

* `HTTP_PORT`: Port this app will use

* `SESSION_NAME`: `express-session` `name`

* `SESSION_SECRET`: `express-session` `secret`

* `NODE_ENV`: built-in node environment flag