pth3231/lonelywolf

We are creating a game that helps players feel a lot more motivated in walking and running, by letting them freely do their tasks, join guilds, combat with bosses, collect wonderful treasures and trade them with other aspired players.

Welcome, lonelywolf!

Setup

First, if you are a developer or a user who want to investigate about our web application, you have to install Node.js runtime on your machine.

If you want to clone the repository, you need to clone the app using git clone like the following code:

git clone https://github.com/pth3231/lonelywolf.git
cd lonelywolf

or you can download the .ZIP package in this repository.

Next, you have to install Microsoft SQL Server running as a service on your machine, or you can simply use Microsoft Azure and set up a new SQL Server Instance. You can read the following documentation from Microsoft for further detailed information about setting up a new database, or Microsoft Azure SQL Database documentation to have more insights about Cloud platforms.

Run Frontend

After setting up the web app, you have to be in the lonelywolf folder, then use

npm start

to run the web on http://localhost:3000/

Run Backend

After being in lonelywolf, you can use the following syntax (in the new console, in different process) to run your server

// if you want to use nodemon
npx nodemon server.js

// or if you just want to use the ordinary one
node server.js

APIs Configuration

lonelywolf-backend API

In lonelywolf/src/config.json, we can modify some of these keys in order to set up a suitable environment:

{
    // URL of your API
    "api_url": string
}

Inside lonelywolf-backend/routes/, we also have the same JSON file named config.json:

{
    // This is a secret encrypted sequence of characters, which will be used for JWT
    "secret": string,
    // This is the client_id inside Google APIs Console
    "client_id": string,
    // This is the client_secret inside Google APIs Console
    "client_secret": string,
    // URL to your API
    "api_url": string
}

Dependencies

• React
  • axios
  • universial-cookie
  • hooks (useState, useEffect, useNavigate)
  • react-router-dom
  • zustand
  • use-Sound
  • chart.js
  • react-chartjs-2
• Express
  • express-session (replaced by jsonwebtoken)
  • mssql
  • cors
  • body-parser
  • cookie-parser
  • universial-cookie
  • dotenv
  • express.router
  • nodemon
• Microsoft SQL Server (under platforms of Microsoft Azure)
• TailwindCSS

Author

• Phan Thai Hoa (Developer, Engineer)
• Nguyen Quang Minh (Leader, Content Manager)
• Nguyen Ngoc Gia Bao (Designer)
• Pham Ngoc (Designer)

lonelywolf's Issues

Division of server-side and client-side into two separate repos

When we use Vercel or Qovery to deploy these web app, they required us to divide the code into two different repos so that it is much easier to update and maintain.

Set up NGINX with load balancer and reverse proxy