Welcome on the main repository for DeMyth's project.

📋 Table of Contents

1. 🔱 What is Demyth?
2. 🔨 Installation
3. ⚙️ Stack
4. 🚀 Build
5. 🐳 Docker
6. 💯 Tests
7. 🌿 Env variables
8. ☑️ Code analysis and consistency
9. 📈 Releases & Changelog
10. 🐙 GitHub Actions
11. ✨ Misc commands
12. ©️ License
13. ❤️ Contributors

🔱 What is Demyth?

Demyth is a strategy-based web3 browser game, inspired by mythology, where players compete to ascend the rankings. In addition to the game, this project aims to integrate a variety of common full-stack tools, as we will discuss further.

• Frontend Demo: https://demyth-frontend.vercel.app/
• Backend API Demo: https://demyth-render-test.onrender.com

🔨 Installation

First you need to fork/download the monorepo. Secondly, you need these:

Soft	Note
	It is better to have node >= 18.10; if no upgrade it - v18.17.1
	Better to install cli globaly: npm i -g @nestjs/cli

Then, in the root of the monorepo project:

# Install all monorepo's dependencies
yarn install

⚙️ Stack

Frontend

What	Why
	Component library
	All web3modal suff: wagmi, wallet connecct, viem, siwe
	Animation purpose
	twMerge, clsx, cva
	web2 & web3 login with jwt session

Backend

Blockchain

Soon - To come

🚀 Build

In order to build the app for production, in the root, run the following command:

# Build the app
yarn build

# Run the app in production mode
yarn start:dev

🐳 Docker

This app will be Docker ready soon! The Dockerfile will be available at the root of the project.

🔨 Development mode

# Run the frontend in development mode - in frontend folder:
yarn dev

# Run the backend in development mode - in backend folder:
yarn start:dev

🚀 Production mode

# Run the frontend in development mode - in frontend folder:
yarn build
yarn start

# Run the backend in development mode - in backend folder:
yarn build
yarn start:prod

💯 Tests

🧪 Unit and E2E tests

🥒 Acceptance tests

▶️ Commands

Before testing, you must follow the installation steps. Then, run one of the following commands:

#Soon

🌿 Env variables

Environnement files are available in the env directory.

You can create a .env file in this directory to override the default values when starting the project locally.

Environment variables are:

Name	Description	Required	Example value	Limitations
HOST	Host on which the API will be available	✅	http://localhost:3001
NEXT_PUBLIC_WALLETCONNECT_PROJECTID	Wallet connect project ID	✅	25654aeff98f7aaac5b9fff6...
NEXT_PUBLIC_SIGNIN_MESSAGE	Message content to be sign when web3 login is used	✅	❌
NEXTAUTH_SECRET	Secret for NextAuth	✅	❌
NEXTAUTH_URL	Url for NextAuth	✅	http://localhost:3000
MONGODB_URL	Atlas Mongodb URL	✅	``mongodb+srv://....net/`
JSON_TOKEN_KEY	Key for Jwt generation	✅	❌
JSON_TOKEN_EXPIRE	Expire time for Jwt	✅	1d
JSON_REFRESH_TOKEN_KEY	Key for Jwt generation	✅	❌
JSON_REFRESH_TOKEN_EXPIRE	Expire time for Jwt	✅	7d
PORT	Port for backend	✅	3001

☑️ Code analysis and consistency

🔍 Code linting & formatting

🐙 GitHub Actions

This project uses GitHub Actions to automate some boring tasks.

You can find all the workflows in the .github/workflows directory.

🎢 Workflows

Workflows are onlky for frontend at the time.

Name	Description & Status	Triggered on
⚙️ Preview Workflow	Various checks for app health, code quality and tests coverage	push on develop and all pull requests to develop
🚀 Production Workflow	Various checks for app health, code quality and tests coverage	push on main and all pull requests to main

✨ Misc commands

©️ License

This project is licensed under the MIT License.

❤️ Contributors

There is no contributor yet. Want to be the first?