BroResearch/Bro

Bro? - Social network that uses FreeMarker templates and the Resources plugin.

Bro?

Ktor social network to share your posts!

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Usage
3. Roadmap
4. License

About The Project

Post sharing platform where you can personalize, see your favorite user's posts, see the latests posts and share your posts. It uses the most cutting edge technology in the frontend and backend part such as Ktor, Freemarker and Tailwindcss.

Built With

These are the main frameworks/libraries used to build this project.

• 
• 
• 
• 

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need java dependencies to run the gradle commands.

• java

  java -version

Usage

Below is an example of how you can build bro.

1. Clone the repo

   git clone https://github.com/BroResearch/Bro.git

2. cd into it

   cd Bro

3. Execute this command to run

   ./gradlew run

Then, the program responds at http://0.0.0.0:8080 and https://0.0.0.0:8443

Roadmap

• Add mobile support
• Add Api documentation
• Add error viewer
• Add Edit user component
• Fix bugs in the user interface
  • Fix post displayer
  • Fix error displayer

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

License

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