Connect

The social media platform!
See it live »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Connect is a social media platform with real-time text support. It is a two part project. This is the Backend. The Frontend can be found here.

• Connect uses ASP.Net Core including SignalR in the Backend and Angular in the Frontend. It uses PostgreSQL to persist data.
• The UI uses REST API and SignalR to fetch all the data.
• The Backend uses Docker which is hosted on Google Cloud Run.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

• dotnet

  # On Archlinux
  pacman -S dotnet-sdk

Installation

1. Clone the repo

   git clone https://github.com/heronet/connect.git

2. Restore Nuget dependencies

   dotnet restore

3. Run the project

   dotnet run

(back to top)

Roadmap

• Add real-time messaging with SignalR
• Add authentication
• Add photo upload
• Add light / dark theme switcher
• Add likes
• Add comments
• Add pagination
• Add profile page

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 GPLv3 License. See LICENSE for more information.

(back to top)

Contact

Sirat - sirat4757@gmail.com

Project Link: https://github.com/heronet/connect

(back to top)

Acknowledgments

• Img Shields
• Font Awesome
• Othneildrew

(back to top)