Giter VIP home page Giter VIP logo

cosap-webapi's Introduction

Comparative Sequencing Analysis Platform - Web API

GitHub issues GitHub license

RESTful web API implementation to interact with Comparative Sequencing Analysis Platform.

Disclamier: This software is in constant development and NOT READY TO BE USED IN PRODUCTION.

Running the Development Server

As a first step, you need to have Docker and Docker Compose set up. While running the server without Docker might be technically possible, it may require modifications to the source code and is not recommended.

Clone the git repository:

git clone https://github.com/MBaysanLab/cosap-webapi.git
cd cosap-webapi

Set necessary variables in your environment:

Variable Description
COSAP_DJANGO_SECRET A secret key used for signing purposes. Should be set to a unique, unpredictable value and kept secret. Mandatory.
COSAP_DJANGO_HOST Host/domain name that the server can serve. Optional; if empty or not set, only connections from localhost are allowed.
COSAP_DJANGO_DEBUGย  Set to "True" if you want to allow Django debug output. Optional, debug is disabled by default.

If you don't want to set the environment variables in the host environment, you can just replace the environment variables with their values in the docker-compose.yaml file.

Run the containers:

docker compose up -d

This command will build the container image and run the containers in detached mode. If you are building the image for the first time, it might take some time as it requires around 1GB of packages to be downloaded.

You might also need to update the database structure after the containers are started:

docker compose exec web bash -l -c "python manage.py makemigrations && python manage.py migrate"

The development server should now be accessible at http://localhost:8000.

You can view the logs with:

docker compose logs -f -t

You can stop and remove the containers with:

docker compose down

cosap-webapi's People

Contributors

marifergun avatar berkantb0 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.