Nucleus

Contents

• Project Setup
  • Backend
  • Frontend
• Development
  • Branches
• Deploying

---

Project Setup

Backend

Recommended Python version : Python 3.10.12

Please develop the backend in a virtual environment.

1. First, clone the repository.

   git clone https://github.com/TeamUnity2023/unity_nucleus.git

2. Then run this command to activate a python environment. After that activate the environment.

   In Unix

   virtualenv --python=python3 ~/venv/MyVirtEnv
   source ~/venv/MyVirtEnv/bin/activate

   In Windows,

   python -m venv "nucleus"
   nucleus\Scripts\activate

   If your Python virtual environment works fine, then in the command line should be something similar to this.

   (nucleus) C:\Users\Foo

3. Now you have to install the required python libraries. Then run this command.

   pip install -r requirements.txt

4. Run this command to run the local server

   python manage.py runserver

5. Use deactivate command to close the virtual environment.

---

Frontend

Recommended Flutter version : 3.10.6
Recommended Dart SDK versions : >=3.0.6 <4.0.0

1. Assuming that you have already cloned the repository, Open the frontend directory in the flutter environment. To get the dependencies, run Following command in the terminal. (You should be in the frontend directory.)

   flutter pub get

2. Now you have to build the app by running the relevant command.

   • For Android

   flutter build apk

   • For IOS

   flutter build ios

   • For Windows

   flutter build windows

   • For MacOS

   flutter build macos

   • For Linux

   flutter build linux

   • For Web

   flutter build web

   3. After running above commands succesfully, you will able to locate the executable in the following paths :
      

      • Android : build/app/outputs/flutter-apk/

      • IOS : build/ios/

      • Windows : build/windows

      • MacOS : build/macos/Build/Products/Release/

      • Linux : build/linux/

      • For Web, you can run the project by running the following command :

      flutter run -d web

Note:

For the app to work, both the computer in which the django server is running and the device in which the flutter app is running, should be connected to the same Wifi (LAN).