Getting Started

🍕 Welcome to the "Here's How We Roll" section of the RisingBrain Wiki!

This is where we break down the process of setting up the RisingBrain project into fun-sized, bite-sized chunks. Forget about headache-inducing manuals - we're here to get you started on a smooth and enjoyable journey.

Buckle up and let's go! 🎢

Setting Up

Get the Party Invitation (Repository) 🎟️

The first step to kickstart the party 🥳 (also known as the "Project Setup") is getting your personal invitation from our GitHub repository. Don't worry, we won’t ask for an RSVP!

✨ Feel free to clone our repository to your local machine using this command:

git clone https://github.com/ttt246/Brain.git

You've now successfully cloned our repository! You're on a roll!🔥

Explore the Mansion (Directory) 🏰

• Next, we'll navigate into our project's main backend directory. Just type in the following command in your terminal:

  cd Brain

• Next, create the virtual environment.

  On Windows:

  python -m venv [virtualenv name]
  

  venv\Scripts\activate.bat\

  On Linux:

  python3 -m venv [virtualenv name]

  source [virtualenv name]/bin/activate

• And next step, install all required packages using the provided requirements.txt file.

  pip install -r requirements.txt

• Last, start the FastAPI application with hot reloads enabled using Uvicorn.

  uvicorn app:app --reload

And voilà, the RisingBrain project is running! Music's up, lights on, the doors are open. Feel free to mingle with your awesome new AI buddies!

Spicing Up Your Browser 🌶️

• Grab Your Scuba Gear 🤿 (Clone the Repository)

Time to put on your scuba gear and dive deep into the ocean of knowledge (aka GitHub). In this expedition, our precious treasure is the 'RisingBrain Extension' repository.

To embark on your underwater adventure, simply clone our repository to your local submarine (err...machine) with this handy-dandy command:

git clone https://github.com/ttt246/Brain.git

• Dance with the Fishes 🐠 (Navigate to Directory)

cd Extension

• Uncover the Lost City of Atlantis 🗺️ (Install Required Packages)

Now, it's time to uncover the magic!✨ You might need some ancient artifacts for your future quests. Don’t worry, our famous ancient spell (npm command) does all the heavy lifting for you:

npm install

• Summon the Kraken! (Build the Project) 🐙

Time to summon the mighty Kraken to build our RisingBrain extension! Who is the Kraken, you ask? It's your friendly npm run build command:

npm run build

• Meet Poseidon 🧜‍♂️ (God of the Sea and Now, Your Extension)

  • First, take a deep breath and swim to the surface to the Extensions page in your Chrome browser (or any Chromium-based browser you prefer)
  • Look around and find a switch labeled "Developer mode." Don't hesitate – flip that switch on!
  • Now, "Load unpacked" button has appeared like a magical pearl! Click on it.
  • A wild file chooser dialog appears! Navigate to your build directory that the Kraken has kindly created for you.

• Celebrate with the Mermaids (Tips and Tricks) 🧜‍♀️

  • Remember, RisingBrain extension is like a pet dolphin 🐬 - the happier it is, the better it performs. Always keep it updated with the latest versions.

  • Having trouble with your extension? Swim back through the steps and check again. If it still misbehaves, reach out to our friendly sea turtles known as Support. We're always here to help!

Party Favors (Tips and Tricks) 🎁

• If you find the music too loud or the lights a bit off, don't worry, feel free to tweak the .env file located at the project's root directory to customize your party experience.

• Are you the DJ of the night and want to play with the latest funky features? Always git pull the latest changes from the repository before you start.

So fellas, that's your golden access to the AI club - RisingBrain. Enjoy the party and remember, if you need any assistance - we are just a 'Help' click away!

Happy coding, you party animal! 🎉😉