Skip to content

JohnJCZhou/content-curation

 
 

Repository files navigation

Kolibri

Django app for the Content Curation project.

Getting the codebase and configuring your git path

  • Fork the repo to your own remote github repository first

  • Then, clone the repository into your local files

    git clone https://github.com/fle-internal/content-curation.git

  • Type in git remote -v to check what origin and upstream are tracking. Make sure origin refers to your remote repository, yourusername/content-curation.git and upstream refers to fle-internal/content-curation.git. If not, use these commands:

    Tracking upstream:

      `git remote add upstream git@github.com:fle-internal/content-curation.git`
      `git remote set-url upstream git@github.com:fle-internal/content-curation.git`
    

    Tracking origin:

      `git remote set-url origin git@github.com:yourusername/content-curation.git`
    

Setting up your environment

  • Download Python 2.7.10 if you don't have it already.

  • Install pip if you don't have it already.

  • Set up your virtual environment

    pip install virtualenv Installs your virtual environment

    virtualenv yourfoldername Creates a folder for your virtual environment

    source yourfoldername/scripts/activate Activates your virtual environment

    IMPORTANT: Make sure you have done the above steps and are inside your virtual environment before continuing on.

    pip install -r requirements.txt Installs python dependencies within your virtual environment

  • install node if you don't have it already. Install the dependencies listed in packages.json: npm install

  • Set up the database

    cd contentcuration

    python manage.py makemigrations

    python manage.py migrate

  • Run your server and start developing! Make sure you're in your virtual environment each time before you run the server.

    python manage.py runserver

    Visit the localhost link that is presented on your console.

Adding files, committing, and pushing to your local repo:

When you're ready to submit your work, make sure you are not in your virtual environment. Type in deactivate to exit your virtual environment.

Then:

`git add .`
`git commit -m "message that says what your code accomplished"`
`git push origin yourbranch`

And visit the pull request page to get your code in!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 54.9%
  • HTML 18.0%
  • Python 15.9%
  • CSS 11.2%