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

https://github.com/monquess/gather-flow-frontend

Platform built with React and NestJS that allows users to create, manage, and book events.
https://github.com/monquess/gather-flow-frontend

mantine react tanstack-react-query typescript zustand

Last synced: 2 months ago
JSON representation

Platform built with React and NestJS that allows users to create, manage, and book events.

Awesome Lists containing this project

README

          










## Overview

An advanced and elegant event and ticket managing application for creating and sharing events, built with React.

## Table of Contents

- [Project setup](#project-setup)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Running the client](#running-the-client)
- [API](#api)
- [Starting the application](#starting-the-application)
- [License](#license)

## Project setup

### Dependencies

Before starting, ensure the following dependencies are installed on your system:

- [Node.js](https://nodejs.org/en) v18.8 or higher.

### Installation

Clone the project repository to your local machine

```bash
$ git clone https://github.com/monquess/gather-flow-frontend
```

Go to the project directory

```bash
$ cd gather-flow-backend/
```

Copy the example .env file and fill in any necessary values

```bash
$ cp .env.example .env
```

Install project dependencies

```bash
$ npm ci
```

### API

This application depends on a API for data operations such as authentication, event management, and payments.

You can find the backend repository here [gather-flow-backend](https://github.com/monquess/gather-flow-backend)

> [!NOTE]
> Make sure the server is running and properly configured before starting the client.

### Starting the application

Run the client application using the following command

```bash
$ npm run dev
```

Once the client has started successfully, the apllication will be accessible at http://localhost:4200 or on another port specified in the _.env_ file

## License

Project is licensed under [MIT License](LICENSE).