snowballtools

Setup

• Clone the snowballtools repo

  git clone git@github.com:snowball-tools/snowballtools-base.git
  

• In root of the repo, install depedencies

  yarn
  

• Build packages

  yarn build --ignore frontend
  

Backend

• Change directory to packages/backend

  cd packages/backend
  

• Load fixtures in database

  yarn db:load:fixtures
  

• Set githubOauth.clientId and githubOauth.clientSecret in backend config file

  • Client ID and secret will be available after creating Github OAuth app
    • https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app
    • In "Homepage URL", type http://localhost:3000
    • In "Authorization callback URL", type http://localhost:3000/projects/create
    • Generate a new client secret after app is created

• Start the server

  yarn start
  

Frontend

• Change directory to packages/frontend in a new terminal

  cd packages/frontend
  

• Copy the graphQL endpoint from terminal and add the endpoint in the .env file present in packages/frontend

  REACT_APP_GQL_SERVER_URL = 'http://localhost:8000/graphql'
  

• Copy the GitHub OAuth app client ID from previous steps and set it in frontend .env file

  REACT_APP_GITHUB_CLIENT_ID = <CLIENT_ID>
  

Development

• Start the React application

  yarn start
  

• The React application will be running in http://localhost:3000/

Production

• Build the React application

  yarn build
  

• Use a web server for hosting static built files

  python3 -m http.server -d build 3000