Graux

Aux Battles For The Web

Application Live At https://graux-sage.vercel.app

Introduction

An Aux battle is a music competition between 2 or more people. Typically a 1v1 or 1v1 bracket. Graux is a web application which let's you create aux battles with your friends.

Main features:

Create Battles specifying how long the battle should run
Query Battles created in the platform with sort,search and pagination
Query Users of the platform with sort , search and pagination
Login/Register with jwt
Send request to people to join your battle
Choose song for your battle
Liking/Disliking Battle
Vote for a user in a battle
Comment in a Battle
Determine Winner of the battle
Check Profile of a user
Manage your Battles

Technologies Used

The server is a Graphql server made with Nodejs and Apollo Server .
It uses Postgresql as database with Typeorm as orm .
The code for the Server is located at src directory in the root folder.

The Frontend is based on Next.js
Communication with the graphql server is done with Apollo Client
It uses Chakra UI for styling
The code for the Frontend is located at client directory in the root folder.

Running The Project Locally

First you have to clone this directory . Now to run the backend , on the root directory run

npm install

Next , create .env file in the root directory
The file should look like this .

NODE_ENV="development"
PORT="3000"

DATABASE_PORT="5432"
DATABASE_TYPE="postgres"

DATABASE_HOST=""
DATABASE_USERNAME=""
DATABASE_PASSWORD=""
DATABASE_NAME=""

LOCAL_DATABASE_HOST=""
LOCAL_DATABASE_USERNAME=""
LOCAL_DATABASE_PASSWORD=""
LOCAL_DATABASE_NAME=""

ACCESS_TOKEN_SECRET=""
REFRESH_TOKEN_SECRET=""
LAST_FM_API_KEY=""

Fill the blank strings with the necessary value. If you wanna run this project locally then fill the local database fields and if u have a postgres instance running somewhere then fill the database fields.

Now on the root folder , run