Skip to content

Cloud-CV/CloudCV

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
aws
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CloudCV

Join the chat at https://gitter.im/Cloud-CV/Lobby Build Status Code Health Coverage Status

How to Setup

  1. Install git, postgresql version >= 9.4, virtualenv and Node.js version >= 6 in your computer, if you don't have it already. Please check that the python version you are using for the project is 2.7.x. If you are having trouble with postgresql on Windows check this link postgresqlhelp.
  2. Get the source code on your machine via git
    git clone git@github.com:Cloud-CV/CloudCV.git cloudcv
    
    If you have not added ssh keys to your GitHub account then get the source code by running the following command
    git clone https://github.com/Cloud-CV/CloudCV.git cloudcv
    
  3. Create a python virtual environment and install python dependencies.
    cd cloudcv
    virtualenv venv
    source venv/bin/activate  # run this command everytime before working on project
    pip install -r requirements/dev.txt
    
  4. Rename settings/dev/settings.sample.py as settings/dev/settings.py and change credentials in settings/dev/settings.py
    cp settings/dev/settings.sample.py settings/dev/settings.py
    
    Use your postgres username and password for fields USER and PASSWORD in settings/dev/settings.py file.
  5. Create an empty postgres database and run database migration.
    sudo -i -u (username)
    createdb cloudcv
    python manage.py migrate --settings=settings.dev.settings
    
  6. That's it. Now you can run development server at http://127.0.0.1:8000 (for serving backend)
    python manage.py runserver --settings=settings.dev.settings
    
  7. Open a new terminal window with node(>=6) and ruby(gem) install on your machine and type
    cd frontend
    sudo npm install -g yarn
    yarn install
    
    If you running npm install behind a proxy server, use
    npm config set proxy http://proxy:port
    
  8. Now to connect to dev server at http://127.0.0.1:6003 (for serving frontend)
    yarn run dev
    

How to Setup on Windows

  1. Install git, postgresql; tested with postgresql installer by bigsql version >= 9.4, and Node.js version >= 6 in your computer & python 2.7.x , if you don't have it already.
  2. Get the source code on your machine via git
    git clone git@github.com:Cloud-CV/CloudCV.git cloudcv
    
    If you have not added ssh keys to your GitHub account then get the source code by running the following command
    git clone https://github.com/Cloud-CV/CloudCV.git cloudcv
    
  3. Open a command prompt and Install python dependencies.
    cd cloudcv
    pip install -r requirements\dev.txt
    
  4. Rename settings/dev/settings.sample.py as settings/dev/settings.py and change credentials in settings/dev/settings.py
    copy settings\dev\settings.sample.py settings\dev\settings.py
    
    Use your postgres username and password for fields USER and PASSWORD in settings/dev/settings.py file.
  5. Create an empty postgres database and run database migration.
    Start Postgresql server
    Open psql prompt
    createdb cloudcv
    In the command prompt,
    python manage.py migrate --settings=settings.dev.settings
    
  6. That's it. Now you can run development server at http://127.0.0.1:8000 (for serving backend),
    python manage.py runserver --settings=settings.dev.settings
    
  7. Open a new terminal window with node(>=6) and ruby(gem) install on your machine and type
    cd frontend
    npm install -g yarn
    yarn install
    
    If you running npm install behind a proxy server, use
    npm config set proxy http://proxy:port
    
  8. Now to connect to dev server at http://127.0.0.1:6003 (for serving frontend)
    yarn run dev
    

Contribution guidelines

If you are interested in contributing to CloudCV, follow our contribution guidelines.