Git Product home page Git Product logo

origami's Introduction

Origami

Build Status Coverage Status Dependency Status devDependency Status styled with prettier

Setting the environment variables

  • origami.env stores all the environment variables necessary to run Origami.
  1. HOST should be set to the hostname of the server
  2. PORT should be set to the port you want the server to listen on. (Generally 80)
  3. DB_NAME will be used to set the name for your postgres database
  4. DB_PASS will be used to set the password for the database user. This is also the admin password
  5. DB_USER is the username for a user who can modify the database. This is also the admin username
  6. DB_USER_EMAIL stores the email for the admin
  7. DB_HOST should be set to postgres in production and localhost in development
  8. REDIS_HOST should be set to redis and localhost in development

To create the file, cp origami.env.sample origami.env and edit the file with the above fields.

  • Origami/outCalls/config.js stores config variables needed by the UI.
  1. CLIENT_IP should be set to the same value as HOST in origami.env
  2. CLIENT_PORT should be set to the same value as PORT in origami.env
  3. For DROPBOX_API_KEY , check step 3 of configuring Origami

Production setup instructions

Use docker to setup Origami on production

Running the server

You can run the server with the help of docker and docker-compose.

Run docker-compose up

Development setup instructions

This application requires node v5+ and Python 2.7/3.4+

Create a Virtual Environment

  1. pip install virtualenv
  2. virtualenv venv venv = Name of virtualenv
  3. source venv/bin/activate

Note: Step 2 will create a folder named venv in your working directory

Getting the code and dependencies

  1. Clone this repository

  2. Navigate to the repo. Usually cd Origami/

  3. Add all the python dependencies. pip install -r requirements.txt

  4. Add all the javascript dependencies yarn (preferably) or npm install

  5. Setup redis docker run -d -p 6379:6379 --name origami-redis redis:alpine

  6. Setup the environment

    source origami.env

Setting up the database

Create all the tables

python manage.py makemigrations
python manage.py migrate

Create admin account

python manage.py initadmin

Start the server

  1. Start the server by python manage.py runserver --noworker
  2. Start the worker by python manage.py runworker
  3. node server.js
  4. Go to localhost:8000 Visit Read the docs for further instructions on Getting started

License

This software is licensed under GNU AGPLv3. Please see the included License file. All external libraries, if modified, will be mentioned below explicitly.

origami's People

Contributors

tocttou avatar avaisp avatar owenl131 avatar vpn1997 avatar gupta-utkarsh avatar tendstofortytwo avatar pavan-simplr avatar idealadarsh avatar fristonio avatar gautamjajoo avatar dexter1691 avatar nu11us avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.