Skip to content

Commit

Permalink
Merge pull request #186 from BibliothecaDAO/main
Browse files Browse the repository at this point in the history
updates
  • Loading branch information
ponderingdemocritus authored Mar 31, 2024
2 parents 94b5551 + af27e73 commit 3cdcc8c
Show file tree
Hide file tree
Showing 55 changed files with 5,545 additions and 371 deletions.
61 changes: 20 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,61 +8,40 @@
[![discord](https://img.shields.io/badge/join-bibliothecadao-black?logo=discord&logoColor=white)](https://discord.gg/realmsworld)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

![background](/docs/assets/images/bg.png)
![background](/apps/docs/assets/images/bg.png)

# Realms.World
# Realms.World - The Hub for the AW

## The portal to the Realms Autonomous World
### Realms.World is the information and activity hub for the Realms Autonomous World.

Realms.World is the information and activity hub for entrance to the Realms Autonomous World. It includes a comprehensive and interactive marketplace dedicated to the Loot and Realms ecosystem (both on Ethereum and Starknet), ecosystem functionality such as bridging, staking, and NFT minting, and information about the various games of the World. The client is built on Next.js 13, utilizing server and client components to achieve high performance and scalability.
[Realms.World](https://realms.world) is the central hub for the Realms Autonomous World, offering a comprehensive marketplace NFTs on Ethereum and Starknet. Features include:

#### Table of Contents
- L1 Marketplace
- L2 onchain Marketplace
- Onchain Game Catalog
- BibliothecaDAO metrics

- Getting Started
- Contributing
- License
#### Quick Links

### Getting Started

- [`apps/nextjs`](https://bibliothecadao.github.io/frontend) - The next.js Frontend
- [`packages/subgraph`](https://bibliothecadao.github.io/subgraph) - The L1 Starknet Messaging Indexer for Bridge Transactions
- [`packages/apibara`](https://bibliothecadao.github.io/starknet-indexer) = The L2 indexer for Bridge and Marketplace

### Running the app

This will launch storybook and the Realms.World client.

```bash
bun i
```

```bash
bun run dev
```

## Enviroment Variables

Depending on which environment you want to run, either copy the values from `.env.sepolia` or `.env.mainnet` into your `.env` file.

### Documentation

Available at [Realms.World Docs](https://docs.realms.world)
- [Getting Started](#getting-started)
- [Client Documentation](https://docs.realms.world/client-development)
- [Developer Documentation](https://docs.realms.world)
- [Add a Game](https://docs.realms.world/games)
- [Add a Event](https://docs.realms.world/events)
- [Add a Post](https://docs.realms.world/posts)
- [License](./LICENSE)

### Contributing

We welcome contributions from the community to help improve Realms.World. If you are interested in contributing, please follow these steps:
We welcome contributions from the community to help improve Realms.World.

1. Fork the repository.
1. Fork the repository. Read the [guide](https://docs.realms.world/)
2. Create a new branch for your changes.
3. Make your changes and commit them to your branch.
3. Make your changes and commit them to your branch. Make sure CI passes.
4. Submit a pull request with a detailed description of your changes.

We will review your contribution and provide feedback. Once your changes have been approved, they will be merged into the main branch.

### To add a Game

Check out the docs at [Add Data Docs](https://docs.realms.world/data) - WIP for Loot Survivor mods

### License
## License

Realms.World is an open-source project released under the MIT License. This license allows you to freely use, modify, and distribute the code, as long as you include the original copyright and permission notice in any copy of the software or substantial portions of it.
10 changes: 0 additions & 10 deletions apps/docs/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions apps/docs/Gemfile

This file was deleted.

82 changes: 0 additions & 82 deletions apps/docs/Gemfile.lock

This file was deleted.

15 changes: 0 additions & 15 deletions apps/docs/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions apps/docs/_config.yml

This file was deleted.

Binary file removed apps/docs/assets/images/games.png
Binary file not shown.
42 changes: 0 additions & 42 deletions apps/docs/frontend/index.md

This file was deleted.

19 changes: 0 additions & 19 deletions apps/docs/frontend/marketplace.md

This file was deleted.

52 changes: 0 additions & 52 deletions apps/docs/index.md

This file was deleted.

10 changes: 0 additions & 10 deletions apps/docs/starknet-indexer.md

This file was deleted.

9 changes: 6 additions & 3 deletions apps/nextjs/next.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Importing env files here to validate on build
import "./src/env.js";
import "@realms-world/auth/env.js";
import { fileURLToPath } from "url";
import createJiti from "jiti";

// Import env files to validate at build time. Use jiti so we can load .ts files in here.
createJiti(fileURLToPath(import.meta.url))("./src/env");

import createMDX from "@next/mdx";

Expand All @@ -12,6 +14,7 @@ const config = {
"@realms-world/api",
"@realms-world/auth",
"@realms-world/db",
"@realms-world/ui"
],
/** We already do linting and typechecking as separate tasks in CI */
eslint: { ignoreDuringBuilds: true },
Expand Down
1 change: 0 additions & 1 deletion apps/nextjs/src/app/blog/PostGrid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ async function getData() {
const PostGrid = async () => {
const { articles } = await getData();

console.log(articles);
const postPreviews = articles.map((post, index) => (
<PostPreview key={index} {...post} />
));
Expand Down
3 changes: 1 addition & 2 deletions apps/nextjs/src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import "@rainbow-me/rainbowkit/styles.css";

import { cache } from "react";
import { headers } from "next/headers";
import { env } from "@/env";
import { TRPCReactProvider } from "@/trpc/react";

import { Footer } from "./_components/Footer";
Expand Down Expand Up @@ -77,7 +76,7 @@ const description =

export const metadata: Metadata = {
metadataBase: new URL(
env.VERCEL_ENV === "production"
process.env.VERCEL_ENV === "production"
? "https://realms.world"
: "http://localhost:3000",
),
Expand Down
Loading

0 comments on commit 3cdcc8c

Please sign in to comment.