Skip to content

Installation and Setup

Alan Wu edited this page Jul 26, 2023 · 3 revisions

To set up the SPARC Portal on your machine, go through the following steps:

  • Clone the repository to your local machine.
  • Unlike the Data Management Platform, the SPARC Portal runs on Node 12 or higher. NVM is a good Node Management library to manage multiple node versions on your machine. A good article that gives good instructions on how to install NVM can be found here(make sure to start following instructions from the middle of the article, the first part explains the wrong way to install NVM!)
  • Once you have NVM installed, you can switch to the appropriate node version by first installing it on your machine (nvm install 12) and then setting it to use that version using the command nvm use 12.
  • If you have zsh terminal setup on your machine, open your .zshrc file in the terminal using an editor (such as vim .zshrc) and add the environment variables that were sent to you. These will be used throughout the app once it's running on your local machine.
  • Save your .zshrc file and type the command source .zshrc. This will automatically run your .zshrc file in the background so that it could be used when the app is running on your machine.
  • Setup environment variables - please refer to this section.
  • Setup the SPARC API, please refer to this page.
  • In a new terminal tab, cd into the repository you cloned. Run yarn install to install dependencies and then yarn dev to run the app. The SPARC Portal should now be running on localhost:3000
Clone this wiki locally