Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kendoriddy/troohq


https://github.com/kendoriddy/troohq

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Project Name

PROJECT-X

## Table of Contents

- [Description](#description)
- [Features](#features)
- [Live Demo](#live-demo)
- [Getting Started](#getting-started)
- [Cloning the project](#cloning-the-project)
- [Getting packages and dependencies](#getting-packages-and-dependencies)
- [Building](#building)
- [Running](#running)

## Description

PROJECT-X is a payment platform that allows users to view their payment transactions and add payments.

![](./src/assets/images/png/screen0.png)
![](./src/assets/images/png/screen1.png)
![](./src/assets/images/png/screen2.png)
![](./src/assets/images/png/screen3.png)

## Features

List the key features of your payment platform. This can include things like:

- User authentication and registration
- Payment processing
- Dashboard for users to manage their payments
- Reporting and analytics

## Live Demo

[Live demo](https://project-x-by-troo.netlify.app/)

## Getting Started

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

### Cloning the project

```
git clone https://github.com/kendoriddy/trooHQ.git

```

```
cd

```

### Getting packages and dependencies

To get all package modules required to build the project run:

```
npm install
```

every package module required to build the project is listed in the package.json file. this is used as a reference to get all dependencies.

### Building

To build the project run:

```
npm run build
```

after you run this successfully you'd locate the build from in the `build` folder located from the parent directory of the project.

### Running

To run the program on a browser through a server run this command in your cli

```
npm start
```

This should open the page in your localhost on port 3000. then you'd be able to view the built page generated using webpack.