miffybruna/robotsbuildingeducation

Robots Building Education

Introduction

This document helps people set up this application on their device. It also servces as educational material for Patreon members learning how to code.

Contact

• Please join this Discord community for more casual & information conversation about this app: Discord

• Subscribe or support more content on Patreon: Robots Building Education

• Use thew app @ https://robotsbuildingeducation.com

RO.B.E

Robots Building Education is a research project centered around decentralized finance and education.

In 2023, it takes the form of an AI cofounder that generates scholarships through "work" created by users interacting with AI. It is strongly recommended to be subscribed to GPT-4 while working with the codebase.

Code Quality

Eventually, we want refinements to take us to a level where the code is so readable and intuitive that people on social media can casually understand it with little or no experience.

So this means improving the quality of comments, variable names and data flow over time. The point isn't to write epicly awesome software - the point is to be teachable and inspiring for newcomers. The code should be good enough that it explains itself in a simple screenshot or carousel of screenshots... ideally!

Educational material

Learn more about the codebase here: codebase details

Forking RO.B.E

Firestore 🔥

You will need to set up a firebase project. A tutorial can be found on Patreon. Thi project includes the following services:

1. Authentication
2. Firestore
3. Hosting
4. Functions
5. Analytics

API Keys 🔐

.env files are like secret files that are kept on your computer. If you take a look at this file, you'll see that Github ignores sending this file to the shared codebase. This is a security practice to keep keys safely hidden from the public since keys grant access to paid services.

1. You'll need to create an account with OpenAI's API. The key definition can be found as OPENAI_API_KEY in a .env file that you have to create under /app/functions - Example

2. You'll need to create an account with Firebase's API. The definition can be found as VITE_FIREBASE_API_KEY under /app. The VITE_ is specific to the application's Vite build and requires the VITE_ header. - Example

3. There is a VITE_PATREON_PASSCODE definition in the codebase. They're mostly feature passcodes that get stored to local storage. Use whatever passcode you want or remove it. - Example