https://github.com/minusinfinite/nobebbs
Project 2 Repo
https://github.com/minusinfinite/nobebbs
Last synced: about 1 year ago
JSON representation
Project 2 Repo
- Host: GitHub
- URL: https://github.com/minusinfinite/nobebbs
- Owner: minusInfinite
- Created: 2021-09-07T09:14:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-05T12:01:15.000Z (over 1 year ago)
- Last Synced: 2025-02-06T22:30:10.195Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://nobebbs.onrender.com/
- Size: 2.2 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NodeBBS
A Modern Bulletin Board System in Node JS and Express with a Classic look
[Live Demo](https://nobebbs.onrender.com/)
## Contents
[Local Deployment](#local-deployment)
[To-Do](#to-do)
[Examples](#examples)
## Local Deployment
This CRM uses [MySQL](https://dev.mysql.com/) as it's database and
[Sequelize](https://sequelize.org/) as the ORM for providing schema models and queries.
Be sure to have MySQL setup an running before you download.
### Download
In your terminal download the repo
```terminal
git clone https://github.com/minusInfinite/nobeBBS.git
```
Once downloaded install the dependencies with NPM
```terminal
npm install
```
## Environment Setup
You will also need to edit the .env.EXAMPLE file to .env with the following
### Development
>
> DBNAME - _The database Name_
>
> DBUSER - _Your server or database Username_
>
> DBPASS - _Your server or database password_
### Required
>
> CSECRET - _Random characters for the Session Cookie Secret_
>
> ADMINPASS= _Set the initial Administrator Password_
### Live
> DB_URL - _If your using a cloud hosted DB Url_
Once you .env is setup you should be able to run the server
```terminal
npm start
```
Or for development
```terminal
npm run dev
```
## To-Do
- Create the Admin Dashboard for full forum management.
- Add some kind of WYSIWYG editor
- Sanatise text input from code injection.
- If you would like to add features please raise an issue or PR.
## Example
[Live Demo](https://nodebbs-demo.herokuapp.com/)
