SubHub

A Subscription Management Platform
Explore the docs » (work in progress)

View Demo

Table of Contents

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

About The Project

SubHub is a comprehensive subscription management application designed to help users efficiently manage their subscriptions. It provides a user-oriented, versatile solution for organizing subscription services.

(back to top)

Built With

• 
• 
• 

  (back to top)

Getting Started

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

Prerequisites

• node
• npm
• golang

Installation

1. Clone the repo

   git clone https://github.com/pxs4528/SubHub

2. Install NPM packages

   cd frontend
   npm install
   npm run dev
   frontend server should start at localhost:3000

3. Initialise Go

   cd backend
   make dev
   backend server should start at localhost:8080

(back to top)

Usage

2023-12-10.03-36-48.mov

(back to top)

Roadmap

• feat: Login/ Signup
• feat: 2fa
• feat: Creating, Editing, Deleting Subscription
• feat: converting to Progressive web app next-pwa
• feat: Responsive Design
• feat: Dashboard action center with visualisations (d3.js)
• feat: PDF Parser

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

(back to top)

Contributing

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. 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.txt for more information.

(back to top)