Subscription Management

A tool to track, manage, and organize your subscriptions, with reminders
Explore the docs »

View Demo · Report Bug · Request Feature

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

Subscription Manager is a simple, easy-to-use tool designed to help users track, manage, and organize their subscription services. Whether it's streaming platforms, software tools, or gym memberships, this app allows users to keep a close eye on all recurring payments in one place, ensuring they never miss a renewal or forget to cancel a subscription.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy of the project up and running, follow these steps. This guide will help you set up the environment for Subscription Management

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Node.js (Recommended version: >= 22.12)

  • Install from: Node.js

• MongoDB (for database management)

  • Install from: MongoDB

• npm (Node package manager)

  • If you have Node.js installed, npm should be installed automatically. You can verify by running:

    npm -v

Installation

1. Clone the repo

   git clone https://github.com/BinaryBeast007/subscription-management.git

2. Navigate into the project directory:

   cd subscription-management

3. Install NPM packages

   npm install

4. Set up environment variables: Create a .env file in the root directory of the project and add the following configuration:

   # PORT
   PORT=5500
   SERVER_URL="http://localhost:5500"
   
   # ENVIRONMENT
   NODE_ENV='development'
   
   # DATABASE
   DB_URI="mongodb+srv://myDatabaseUser:D1fficultP%40ssw0rd@cluster0.example.mongodb.net/?retryWrites=true&w=majority"
   
   # JWT AUTH
   JWT_SECRET="dummy_jwt_secret_key"
   JWT_EXPIRES_IN="1d"
   
   # ARCJET
   ARCJET_KEY="ajkey_demo_01jkkdm882f67t2yz6qe4rzsdc"
   ARCJET_ENV="development"
   
   # UPTASH
   QSTASH_URL="https://qstash.upstash.io"
   QSTASH_TOKEN="ey_demo_token"
   QSTASH_CURRENT_SIGNING_KEY="sig_demo_key_1"
   QSTASH_NEXT_SIGNING_KEY="sig_demo_key_2"
   
   # NODEMAILER
   EMAIL_USER="youremail@example.com"
   EMAIL_PASSWORD="your-email-password"

5. Start the development server: Run the following command to start the application:

   npm run dev

   The application should now be running locally on http://localhost:5500

6. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin BinaryBeast007/subscription-management
   git remote -v # confirm the changes

(back to top)

Usage

The Usage section is currently in progress and will be updated with detailed examples and instructions shortly. Please stay tuned for further updates.

(back to top)

Roadmap

The roadmap is under development, and specific details will be added soon. Please check the open issues for 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)

Top contributors:

(back to top)

License

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

(back to top)