Skip to content

About

API for tracking and managing recurring subscriptions. Features include adding, updating, and deleting subscriptions, automated email renewal reminders, customizable templates, and user account management. Stay on top of your subscriptions with ease!

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Subscription Tracker

A Node.js application to manage and track subscriptions, users, and workflows. This project provides RESTful APIs for authentication, subscription management, and user workflows, with MongoDB as the database.

Features

  • User authentication (register, login)
  • Subscription CRUD operations
  • User management
  • Workflow management
  • Email notifications
  • Environment-based configuration

Project Structure

├── app.js                  # Main application entry point
├── config/                 # Configuration files
├── controller/             # Route controllers
├── database/               # Database connection
├── middleware/             # Express middlewares
├── model/                  # Mongoose models
├── routes/                 # API route definitions
├── utils/                  # Utility functions (email, templates, etc.)
├── package.json            # Project metadata and dependencies

Getting Started

Prerequisites

  • Node.js (v16 or higher recommended)
  • MongoDB instance (local or cloud)

Installation

  1. Clone the repository:
    git clone <repo-url>
    cd subscription-tracker
  2. Install dependencies:
    npm install
  3. Create a .env file in the root directory and configure your environment variables (see .env.example if available).

Running the Application

npm start

The server will start on the port specified in your .env file (default: 3000).

API Endpoints

  • /api/auth - Authentication routes
  • /api/subscriptions - Subscription management
  • /api/users - User management
  • /api/workflows - Workflow management

Refer to the controller and route files for detailed endpoint information.

Scripts

  • npm start - Start the server
  • npm run dev - Start the server with nodemon (if configured)

License

MIT

About

API for tracking and managing recurring subscriptions. Features include adding, updating, and deleting subscriptions, automated email renewal reminders, customizable templates, and user account management. Stay on top of your subscriptions with ease!

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages