A library that allows beginners perform basic web animation using normal language (By Team96)

  • By Zuri Training
  • Last update: Aug 11, 2022
  • Comments: 0

#Team96 - Anima_lib

Relevant Links

Working with the Django project

You'll have to install your own virtual environment and install the dependencies. Follow these steps.

  1. Step 1: Navigate into the Backend folder of the cloned repo. From the Team96_Anima-lib folder type --> cd Backend
  2. Step 2: Create your own virtual environment --> virtualenv "whatever name you choose for your virtual environment" e.g virtualenv env
  3. Step 3: Activate your virtual environment --> (name of virtual environment from step 2)\scripts\activate e.g env\scripts\activate
  4. Step 4: Install dependencies --> pip install -r requirements.txt
  5. Step 5: python manage.py makemigrations
  6. Step 7: python manage.py migrate
  7. Step 8: You can now runserver --> python manage.py runserver

Fork and Clone Repository

  1. Visit the Repository to the Project on Github Website: https://github.com/zuri-training/Team96_Anima-lib

  2. Click the "Fork" button on the upper right corner of the Repo page.

  3. Clone the forked repository to your local machine (computer)

    • Click on the "Code" button on the Repo page
    • Copy the URL for the forked Repo. Something like - https://github.com/github_username/Team96_Anima-lib
    • Create a Folder on your Local machine / Computer for the project Workspace
    • Open Command prompt / Terminal in the same folder location
    • In your Terminal, type: git clone https://github.com/github_username/Team96_Anima-lib
    • Ensure that "github_username" in the link is your username!

Add Remote to Upstream

  1. Add git Remote to Upstream:
    • In your terminal, type: git remote add upstream https://github.com/zuri-training/Team96_Anima-lib

Pull from Upstream

  1. Pull from upstream to download all changes in the project using git pull upstream main

Create and checkout a new branch

    • In your terminal, type: git checkout -b new-branch-name The "new-branch-name" can be anything you want to name the branch with.

Finish assigned Task / Issue

  1. Enter the project folder/file and complete your assigned task / feature on your local machine as you would normally do.

  2. When you are ready to add and push your feature or task to the Repo You can confirm if you are in the right branch with: git branch

    • Add your changes using: git add file_name

    • Commit your changes to the branch with a message using git commit -m "Commit message"

      Note: If you only fixed a bug, make your commit message start with "fixed a bug:" then whatever bug you fixed. Something like this: git commit -m "fixed a bug: I corrected the nav bar of the homepage"

Push New Branch to "Origin" Repository

  1. Push your commit to your branch git push origin new-branch-name

Create Pull Request

  1. Once you push the changes to your repo/branch, the Compare & pull request button will appear in GitHub page of your repo.
  2. Click the button and make your request. Leave a comment in your request.
  3. Click Create pull request to open a new pull request.