Manasub

Internet services subscription manager
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. Contributing
5. License

About The Project

Manage your internet services subscriptions with Manasub. Manasub is a web application that allows you to manage your internet services subscriptions.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• docker
• docker compose
• node.js
• pnpm

Installation

1. Clone the repo

   git clone https://github.com/rfdez/manasub.git

2. Install NPM packages

   pnpm install

3. Start the database

   make start_database

4. Create .env.local file inside apps/issm/ with the following content:

    POSTGRES_HOST=localhost
    POSTGRES_PORT=5432
    POSTGRES_USERNAME=manasub
    POSTGRES_PASSWORD=manasub
    POSTGRES_DATABASE=issm
   
    BASIC_AUTH_USERNAME=yourstrongusername
    BASIC_AUTH_PASSWORD=yourstrongpassword

5. Start the application

    pnpm dev

(back to top)

Usage

You can start and stop the database with the following commands:

make start_database

make stop_database

You can lint or fix the code with the following commands:

pnpm lint

pnpm lint:fix

To run the tests you have to ensure that the database is running and then run the following command:

pnpm test

You also can build and run the application with the following commands:

pnpm build

pnpm start

The application will be available at http://localhost:3000. At the moment, there are only three Next.js API routes available:

• An API status endpoint
• An endpoint to create a new subscription
• An endpoint to get all the subscriptions

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

(back to top)