☁️ CloudCV Website
Switch branches/tags
Nothing to show
Clone or download
Latest commit 4836d53 Oct 12, 2018
Permalink
Failed to load latest commit information.
.github Add setup instructions and contribution guidelines (#6) May 12, 2017
apps feat(demo-views): Demos now have different views on home and project … Jul 13, 2018
aws cleanup(nginx): Remove extra newline Apr 10, 2018
cloudcv Add demo embedding and addition of logs (#26) Aug 26, 2017
docker fix(docker): Fix nodejs docker script (#19) Aug 7, 2017
frontend Merge pull request #89 from gautamjajoo/UpdateNews Oct 12, 2018
middleware Add middleware for saving request metrics (#17) Jul 12, 2017
requirements feat(demo-views): Demos now have different views on home and project … Jul 13, 2018
scripts fix(staging): Fix minor errors in volume path (#64) Jan 21, 2018
settings feat(prod-deploy): Add production deploy configuration Jan 21, 2018
tests Demo page loader (#56) Dec 28, 2017
.coveragerc Add Coveralls and Raven Configuration (#13) Jun 20, 2017
.coveralls.yml Add Coveralls and Raven Configuration (#13) Jun 20, 2017
.dockerignore CI/CD Setup: Add AWS and Docker scripts (#10) Jun 15, 2017
.editorconfig Setup basic Django backend (#3) May 11, 2017
.gitignore GCI Task: Added about tabs to the demos (#47) Dec 16, 2017
.landscape.yml Add Coveralls and Raven Configuration (#13) Jun 20, 2017
.pylintrc Add Coveralls and Raven Configuration (#13) Jun 20, 2017
.travis.yml Fix travis (#36) Dec 2, 2017
CODE_OF_CONDUCT.md Add setup instructions and contribution guidelines (#6) May 12, 2017
CloudCV.json.enc Feat(admin): Add analytics dashboard to django admin (#27) Aug 25, 2017
LICENSE Initial commit May 8, 2017
README.md Fix a small typo in README.md (#50) Dec 16, 2017
docker-compose.dev.yml Add news and showcase frontend (#18) Aug 7, 2017
docker-compose.yml CI/CD Setup: Add AWS and Docker scripts (#10) Jun 15, 2017
manage.py Setup TravisCI (#5) May 12, 2017
pytest.ini Add Coveralls and Raven Configuration (#13) Jun 20, 2017
setup.cfg Setup TravisCI (#5) May 12, 2017

README.md

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.