Code Monkey home page Code Monkey logo

snow's Introduction

Snow

Requirement

API Server

  • Python 3
    • python dependencies:
      • django
      • django-cors-headers
      • pillow
      • schema

Website

  • NodeJS >= v20.10.0
  • NPM >= v10.2.3

Deploy

Clone the repo:

git clone https://github.com/NYU-SE/Snow.git snow

API Server

Before first run:

cd snow
ADDR="127.0.0.1:8000"
export SNOW_API_HOST="http://$ADDR"
export SNOW_API_WORKDIR=$PWD # or any other direcotry you wish to store runtime data
python ./manage.py migrate

To run the API server:

python ./manage.py runserver "$ADDR"

Website

Before first run:

cd snow/frontend/website
npm install

To run the website

export VITE_SNOW_API_SERVER="http://127.0.0.1:8000/api" # match with SNOW_API_HOST
npm run dev -- --host 127.0.0.1

Using Nix

If you have Nix installed with flake support, you may use the following command to start the api server and website:

# To start the api server, SNOW_API_WORKDIR will be set to $PWD
nix run /path/to/repo#api
# To start the website, will be served on 127.0.0.1:5173
nix run /path/to/repo#website

snow's People

Contributors

ninlives 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.