Skip to content

dorkodu/forum

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

Dorkodu Forum

Social Discourse @ Dorkodu
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Dorkodu Forum Home Screen Shot Dorkodu Forum Profile Screen Shot

Dorkodu Forum · Social Discourse

  • Join the discussion on Dorkodu Forum and connect with people who share your interests.
  • Find interesting discussions and connect with like-minded people on Dorkodu Forum.

(back to top)

Built With

TypeScript, React, Zustand, Mantine, i18next, NodeJS, Postgres, Docker, Nginx

  • Typescript
  • React.js
  • Node.js
  • Docker

(back to top)

Getting Started

Prerequisites

  • Docker
  • pnpm
    npm install -g pnpm

Installation

  1. Clone the repo
    git clone https://github.com/dorkodu/forum.git
  2. Install PNPM packages
    pnpm install -r
  3. Run docker container & check localhost:8002
    pnpm run docker:dev
  4. Perform database migrations
    docker exec forum_dev-forum_api-1 sh -c "cd /forum/api; pnpm migrate:dev:latest; exit"

(back to top)

Usage

You can use the application as you wish. Production app has a public API (currently not documented) you can use. If you have more questions, check Issues

(back to top)

Roadmap

  • Social network features
  • Login using Dorkodu ID
  • New UI
  • Backend optimizations
  • Uploading images and videos
  • Public API documentation
  • Decentralization

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Berk Cambaz - [email protected]
Doruk Eray - [email protected]

Project Link: https://github.com/dorkodu/forum

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Packages

No packages published