https://github.com/igor-klymenok/dice-betting-api

https://github.com/igor-klymenok/dice-betting-api

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/igor-klymenok/dice-betting-api
• Owner: igor-klymenok
• License: apache-2.0
• Created: 2023-09-02T12:40:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-13T06:55:34.000Z (over 1 year ago)
• Last Synced: 2023-09-13T14:57:24.261Z (over 1 year ago)
• Language: TypeScript
• Size: 73.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Getting Started with the Project

This guide provides detailed instructions on how to set up and run the project. Please make sure you meet the necessary prerequisites before proceeding with the project setup.

## Table of Contents

1. [Prerequisites](#prerequisites)

2. [Installation](#installation)

3. [Running the Project](#running-the-project)

4. [Accessing the GraphQL API](#accessing-the-graphql-api)

## Prerequisites

Make sure you have the following software installed on your system:

- **Node.js**: This project requires Node.js v20 or higher. You can download it from [Node.js official website](https://nodejs.org/).

- **SQLite**: The project uses SQLite for its database. You can download it from [SQLite's official website](https://www.sqlite.org/index.html).

## Installation

1. **Clone the Repository**: Open your terminal and run the following command to clone the project repository.

`git clone [Repository URL]`

2. **Navigate to Project Directory**: Change your current directory to the project folder.

`cd [Project Folder]`

3. **Install Dependencies**: Run the following command to install the required Node.js packages.

`npm install`

## Running the Project

1. **Start the Project**: Execute the following command to start the server.

`npm start`

This command will compile the project and start the server. Wait for the console output that says the server is running.

2. **Verify Server Status**: Open your [web browser](https://localhost:4000) and go to the following URL.

   If everything is set up correctly, you should see the project's landing page.

## Accessing the GraphQL API

You can now use the GraphQL API for querying and manipulating data.

1. **Access the API Endpoint**: Navigate to the GraphQL interface by visiting: [Apollo page](https://localhost:4000)

2. **Execute Queries**: Use the GraphQL interface to execute your queries and mutations.

For more detailed information on the available GraphQL queries and mutations, refer to the project's GraphQL documentation.

---

Feel free to contribute or report issues. Happy hacking!