domedevep / earthdoom Goto Github PK

Earthdoom is a full-stack web-based strategy game built using Typescript, Next.js, React, tRPC, Tailwind, Prisma and more.

The database is handled through mySQL and Planetscale.

Authentication is handled through Clerk.

Front page is developed with Astro.

The application is designed with a modern, responsive and intuitive user interface.

• Next.js
• Prisma
• Tailwind CSS
• tRPC
• React Hot Toast
• React Chart.js
• Clerk
• Tailwind Elements

• Installation
• Usage
• Scripts
• Dependencies
• Contributing
• License

To install the required dependencies, simply run the following command in the project's root directory (/game):

npm install

You now need to retrieve the API keys for Clerk and Planetscale and enter them into .env (you need to rename .env.example to .env)

To start the development server, run the following command:

npm run dev

The application will be available at http://localhost:3000.

This project includes the following npm scripts for development and building:

• build: Builds the application for production.
• dev: Starts the development server.
• postinstall: Generates Prisma client after installing dependencies.
• lint: Lints the codebase using ESLint.
• start: Starts the production server.
• prisma:generate: Generates the Prisma client.
• format: Formats the codebase using Prettier.
• refresh: Removes node_modules, package-lock.json, installs dependencies, and formats the codebase.

If you'd like to contribute to the development of Earthdoom Game, please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name.
3. Make your changes and commit them with clear and concise commit messages.
4. Push your changes to your forked repository.
5. Open a pull request with a description of the changes you've made.

This project is licensed under the MIT License.