A content management system for the Lootchest experience

View Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact

About The Project

This repository houses the Sanity CMS setup for the Chest Opening Experience, providing a structured content backend that powers the dynamic and interactive elements of the game. It allows for seamless content updates, management of chest items, and configuration of rewards, ensuring a fresh and engaging experience for users.

Built With

This project is built with Sanity.io, a unified content platform that delivers structured content to digital experiences. Sanity.io is chosen for its real-time collaboration features, extensibility, and efficient content delivery.

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Ensure you have either Node.js or Bun installed on your system to manage project dependencies and run the development server.

• For Node.js, download and install it from nodejs.org.
• For Bun, you can install it by running the following in your terminal (visit bun.sh for more details):

curl https://bun.sh/install | bash

Installation

1. Clone the repository to get a local copy of the project:

git clone https://github.com/vinnyhoward/loot-chest-cms.git
cd loot-chest

2. Install dependencies using either npm (Node.js) or Bun. Choose the command based on your preference:

Using npm:

npm install

Using Bun:

bun install

3. Configure environment variables by creating a .env file in the root directory of the project. Fill it with your specific values based on the provided .env template:

SANITY_STUDIO_API_PROJECT_ID=<SANITY_STUDIO_API_PROJECT_ID>
SANITY_STUDIO_API_PROJECT_ID=<SANITY_STUDIO_API_PROJECT_ID>

Set up your environment variables: Rename the .env.example file to .env and update it with your specifics.

• PORT: The port your local server will run on (e.g., 3000).

• VITE_API_URL: Your backend API URL. Replace <your_api_url> with the actual API URL.

• VITE_SANITY_PROJECT_ID and VITE_SANITY_DATASET: Replace <your_sanity_project_id> and <your_sanity_dataset> with your Sanity project ID and dataset name. These are necessary for connecting to Sanity.io.

Visit the backend repository for instructions on setting up your <your_api_url>.

Visit the cms repository for instructions on setting up your Sanity environment started.

4. Run the development server to start the project locally. Use the corresponding command for your chosen package manager:

Using npm:

npm run dev

Using Bun:

bun run dev

Access the application by navigating to http://localhost:3333/ in your web browser (or another port if you specified a different one in your .env file).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Vincent Howard - @NiftyDeveloper - [email protected]

Project Link: https://github.com/vinnyhoward/loot-chest

(back to top)