Skip to content

Commit f5a99a6

Browse files
committed
chore: Added local environment installation instructions (npm)
1 parent 7988e8c commit f5a99a6

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

documentation/local-environment.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Guide to Setting up Reactome as a local Environment
2+
**Hello and welcome to the local environment installation guide!**
3+
In an effort to minimize the suffering of all who come here after me I will do my best to assume no pre-exsisting knowledge on github or Angular development.
4+
5+
Feel free to skip ahead if you have already completed some of these steps!
6+
7+
## Step 1: Installing git
8+
If you are rolling your eyes at the pedantry of this guide please skip to the next step.
9+
10+
In order to get a local version of Reactome on your computer, you will need to get the code onto your computer. We will be doing this with the command line tool git which you can install for Windows, Linux or MacOS [here](https://git-scm.com/install/).
11+
12+
Once git is installed clone and enter the repository with the following commands:
13+
````
14+
git clone https://github.com/reactome/WebsiteAngular.git
15+
cd WebsiteAngular
16+
````
17+
this will place a local copy of the project onto you computer and open the folder containing it.
18+
19+
20+
## Step 2: Installing Node
21+
Node is the tool that will compile and run the reactome project. You can download it [here](https://nodejs.org/en/download)!
22+
Once node is installed run the following commands in the ````WebsiteAngular/```` directory.
23+
24+
````
25+
npm install --legacy-peer-deps
26+
npm start
27+
````
28+
29+
After this you should have a fully functional copy of Reactome running on your computer.
30+
31+
If you run into any issues, try your best to follow any instructions in the error message or any advice found online.
32+
33+
# Step 3: Rejoice!
34+
Nothing to do here but reap the benifits of your hard work I guess? Why are you still reading this?

0 commit comments

Comments
 (0)