57 lines
No EOL
1.7 KiB
Markdown
57 lines
No EOL
1.7 KiB
Markdown
# WireChan - Anonymous ImageBoard
|
|
|
|
## Description
|
|
WireChan is an anonymous imageboard built using the Flask framework and MongoDB as its database. It allows users to communicate on various topics without the risk of being identified, offering both anonymous and logged-in posting options.
|
|
|
|
### Features
|
|
- Anonymous and logged-in posting
|
|
- Admin dashboard for moderation
|
|
- Minimal dependencies
|
|
- Minimalistic design
|
|
|
|
## Installation Instructions
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://git.lainlounge.xyz/hornet/wirechan
|
|
```
|
|
|
|
Create a virtual environment using venv:
|
|
|
|
```bash
|
|
python3 -m venv env
|
|
```
|
|
|
|
## Install the required dependencies:
|
|
|
|
```bash
|
|
python3 -m pip install -r requirements.txt
|
|
```
|
|
|
|
## Initialize MongoDB
|
|
|
|
Start MongoDB by creating a new database via the MongoDB shell.
|
|
Ensure the mongod service is running (for Windows, use mongo).
|
|
Start the Flask application in development mode:
|
|
|
|
```bash
|
|
flask run
|
|
```
|
|
Open your browser to view the created page at the specified URL.
|
|
|
|
## How To Use
|
|
|
|
Log in to your Dashboard instance with valid credentials at http://localhost:5000.
|
|
Create a new post by clicking the "Add a new post" button.
|
|
View or manage your posts by logging out and creating a new account if needed.
|
|
|
|
## Additional Features
|
|
|
|
Admin Dashboard: View profiles, posts, history, and moderation statuses.
|
|
Minimal Dependencies: Built-in Flask and MongoDB for ease of use.
|
|
|
|
Please note that WireChan is a work in progress, and there may be issues with the database or server configurations. Documentation will be updated as the project evolves.
|
|
|
|
## Important to know!
|
|
Wirechan doesnt provide the database to the project (yet). |