Skip to content

Launch of the Appventure 🚀

Before setting off to discover the hidden treasures in the world of Appwrite, it's time to prepare our faithful travel companion: the AppVenture. It's much more than just an application; it's your treasure map, your compass, and your loyal companion in your quest to unlock the secrets of every destination we explore! 🧳 You don't need to master it entirely to move forward, but understand that it will be there when you need it!

Launching the AppVenture 🚀

Now that you have an idea of the importance of AppVenture, here's how to launch it:

  1. Clone the workshop branch of the AppVenture repository from GitHub using the following command 🥳start-application.md
bash
# SSH
git clone -b workshop git@github.com:CruuzAzul/app-appwrite-workshop.git

# HTTPS
git clone -b workshop https://github.com/CruuzAzul/app-appwrite-workshop.git
# SSH
git clone -b workshop git@github.com:CruuzAzul/app-appwrite-workshop.git

# HTTPS
git clone -b workshop https://github.com/CruuzAzul/app-appwrite-workshop.git
  1. Install the dependencies by running pnpm install 📦

TIP

If you don't have pnpm installed, you can do so by running npm install -g pnpm or following the installation instructions on the official pnpm website.


It is recommended that you have a version of Node.js greater than or equal to v16.0.0 and a version of pnpm greater than or equal to v8.4.0 🏷️

  1. Launch the application using pnpm dev and open your browser to localhost:3000.

You are now ready to embark on this AppVenture, with your loyal companion, ready to explore the unknown 😎. However, there's a slight hitch: AppVenture can't operate alone. It seems that many fragments of the application are missing! Upon closer inspection, as is often the case, it appears to require a robust backend to function. And guess which backend it prefers? Well, it's Appwrite, of course! 🤔

Key Locations in the AppVenture 🔑

Before you set sail, let's quickly understand the architecture of the AppVenture. This application is built with Next.js, a React framework. It will allow us to communicate with our Appwrite instance and interact with various services such as authentication, data storage, and function execution 📂

Here are some key places in the AppVenture code that will be useful throughout our adventure. Apart from these, you won't need to worry about the rest of the application's code 🧑🏼‍💻

In the Code 📝


1️⃣ Environment Variables: You will find a .env.example file that you can use as a basis to configure environment variables. Make sure to adjust them according to the configuration information you obtained when setting up your Appwrite instance and initializing various services.

WARNING

The only other files you need to modify are located in the src/workshop folder. Everything else is there solely for the proper functioning of the application but won't be necessary for the workshop. Please refrain from making changes outside of this directory! 🙏🏼

2️⃣ Various Services and Components: You'll find all the services and components that you need to complete in the src/workshop directory. You can identify them by the HERE comments in the code. The specific files to modify will be indicated throughout the workshop.

In the Interface 🖥️


1️⃣ The Dashboard: You'll find a dashboard to help you navigate the application and access various features. You can access it by clicking the Dashboard button in the top right corner of the application or by visiting localhost:3000/dashboard.

2️⃣ Your Treasure Map to Complete: You'll find a treasure map to complete as you progress through the workshop, with the coordinates you obtain! To access it, you can click on the buttons that will appear as you advance in the workshop, or by going to localhost:3000/databases.

Now you're ready to embark on this AppVenture, with your faithful companion, ready to explore the unknown 😎. However, there's a slight hitch: AppVenture can't function on its own. It seems that many fragments of the application are missing! Upon closer inspection, as is often the case, it appears that it requires a robust backend to operate. And guess which backend it prefers? Well, it's Appwrite, of course! 🤔

Released under the MIT License.