base on A free and open-source community discussion platform. # Discuit This is the codebase that powers [Discuit](https://discuit.net), which is an open-source community platform, an alternative to Reddit. Built with: - [Go](https://go.dev): The backend. - [React](https://react.dev/): The frontend. - [MariaDB](https://en.wikipedia.org/wiki/MariaDB): The main datastore. - [Redis](https://redis.io/): For transient data. ## Getting started ### Running locally To setup a development environment of Discuit on your local computer: 1. Install Go (1.21 or higher) by following the instructions at [go.dev.](https://go.dev/doc/install) 1. Install MariaDB, Redis, Node.js (and NPM). On Ubuntu, for instance, you might have to run the following commands: ```shell sudo apt update # Install and start MariaDB sudo apt install mariadb-server sudo systemctl start mariadb.service # Install and start Redis sudo apt install redis-server sudo systemctl start redis.service # Install Node.js and NPM sudo apt install nodejs npm ``` 1. Create a MariaDB database. ```shell # Open MariaDB CLI mariadb -u root -p --binary-as-hex # Create a database named discuit (you may use a different name) create database discuit; # Enter exit (or press Ctrl+D) to exit exit; ``` 1. Discuit uses `libvips` for fast image transformations. Make sure it's installed on your computer. On Ubuntu you can install it with: `sudo apt install libvips-dev`. 1. Clone this repository: ```shell git clone https://github.com/discuitnet/discuit.git && cd discuit ``` 1. Create a file named `config.yaml` in the root directory and copy the contents of `config.default.yaml` into it. And enter the required config parameters in `config.yaml`. 1. Build the frontend and the backend: ```shell ./build.sh ``` 1. Run migrations: ```shell ./discuit migrate run ``` 1. Start the server: ```shell ./discuit serve ``` After creating an account, you can run `./discuit admin make username` to make a user an admin of the site. Note: Do not install the discuit binary using `go install` or move it somewhere else. It uses files in this repository at runtime and so it should only be run from the root of this repository. ### Running with Docker 1. **Build the Docker Image** > **Note**: If you need to run discuit on a different architecture, simply change the Dockerfile in the `-f` flag to the appropriate Dockerfile for your architecture, currently we support `linux/amd64` (docker/Dockerfile.amd64), and `linux/arm64` (docker/Dockerfile.arm64). ```shell docker build -t discuit -f docker/Dockerfile.amd64 . ``` 2. **Run the Docker Container** > **Note**: The following command while having a persistent database, the included config.yaml file is not. You will need to mount the file to the container if you want to persist the configuration. ```shell docker run -d --name discuit -v discuit-db:/var/lib/mysql -v discuit-redis:/var/lib/redis -v discuit-images:/app/images -p 8080:80 discuit ``` 3. **Accessing Discuit**: After the container starts, you can access Discuit by navigating to `http://localhost:8080` on your web browser, or to the specific port if you customized the port mapping. 4. **Stopping the Container**: When you're done, you can stop the container by running: ```shell docker stop discuit ``` 5. **Starting the Container Again**: To start the container again, use: ```shell docker start discuit ``` ### Source code layout In the root directory are these directories: - `cli`: Contains the command-line interface. - `core`: Contains all the core functionality of the backend. - `internal`: Contains Go packages internal to the project. - `migrations`: Contains the SQL migration files. - `server`: Contains the REST API backend. - `ui` - Contains the React frontend. ## Roadmap - [x] Dark mode. - [x] User created communities. - UI preferences: - [x] Compact mode. - [x] Enable or disable infinite scroll. - [x] Choose which notifications to get. - [x] Change default feed sort. - Filtering: - [x] Mute communities. - [x] Mute users. - [ ] Filter posts by topic. - [ ] An explore page (modeled after Youtube's home page). - [ ] Filter link-posts by URL or domain. - Moderation: - [x] Pinned posts and comments. - [ ] Lock individual comments (so they cannot be replied to). - [ ] A single page for handling reports for users who moderate multiple communities. - [ ] Temporary bans. - [ ] User and community mentions (@user and +community). - [x] Image posts. - [ ] Poll posts. - [x] Video embeds (Youtube, Vimeo, etc). - [x] Image galleries. - [ ] Server side rendering (for better SEO). - [ ] Direct messages. - [x] Saved posts and comments (modeled after Youtube playlists). - [ ] Multiple feeds (modeled after Twitter Lists). - [ ] Search. - [ ] Moderation log. - [ ] RSS feeds. - [ ] Wiki pages for communities. - [x] User profile pictures. - [x] User badges (displayed on profile page). - [ ] Post drafts. - [ ] History (viewed posts). - [ ] Something like Reddit's flairs to group posts within a community. ## Contributing Discuit is free and open-source software, and you're welcome to contribute to its development. If you're thinking of working on something substantial, however, (like a major feature) please create an issue, or contact [the maintainer](https://discuit.net/@previnder), to discuss it before commencing work. The documentation of the API can be found at [docs.discuit.net](https://docs.discuit.net). ## License Copyright (C) 2024 Previnder This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. ", Assign "at most 3 tags" to the expected json: {"id":"7772","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"