Skip to content

Commit

Permalink
Merge branch 'feature/Project-Setup' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
Kerry-G committed Jan 30, 2018
2 parents 0fef3d8 + 8859538 commit dd835a2
Showing 1 changed file with 5 additions and 29 deletions.
34 changes: 5 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,9 @@ An engineering question and anwser board.
## Getting Started

#### Back-End Installation
Begin by installing the latest version of [Python 3](https://www.python.org/downloads/). Go through the wizard. If you are on Windows make sure to check off **add to environment variables**. This will install *python* or *python3* (if python 2.7 is already installed on your system) globally on your system. The installation of python also calls with *pip* or *pip3* (if python 2.7 is already installed on your system). pip is a package manager for Python.
Begin by installing the latest version of [Python 3](https://www.python.org/downloads/). Go through the wizard. If you are on Windows make sure to check off **add to environment variables**. This will install *python* (if python 3.6 is the only version of python) or *python3* (if python 2.7 is already installed on your system) globally on your system. The installation of python also calls with *pip* or *pip3* (if python 2.7 is already installed on your system). pip is a package manager for Python.

Take the config.py file that was sent to you and place it in the root of the project. Open your shell and cd to the root of the project.

First we need to create a virtual environment to install python modules into.
```
$ pip install virtualenv
```

We use the virtualenv command followed by the name to create a folder 'venv' in the project. This will not be pushed due to the .gitignore file.
```
$ virtualenv venv
```

Next we want to activate the virtual environment so we can install our project's dependencies there.
If on Mac or Linux:
```
$ . venv/bins/activate
```
Else if on Windows:
```
$ . venv/Scripts/activate
```

You should now see *(venv)* before your user name in the shell. Congrats you have a virtual environment.

Now we can install the requirements for our projects. All of our dependencies are installed.
Take the config.py file that was sent to you and place it in the root of the project. Open your shell and *cd* to the root of the project. Now we can install the requirements for our projects.
```
$ pip install -r requirements.txt
```
Expand All @@ -46,11 +22,11 @@ The backend server should now be running on localhost:5000! Hit Ctrl+C in the sh


#### Front-End Installation
Begin by installing the latest version of [Node.js 8](https://nodejs.org/en/). Go through the wizard. If you are on Windows make sure to check off **add to environment variables**. The installation of Node.js also calls with *npm*. npm is a package manager for Node.js.
Begin by installing the latest version of [Node.js 8](https://nodejs.org/en/). Go through the wizard. If you are on Windows make sure to check off **add to environment variables**. The installation of Node.js also comes with *npm*. npm is a package manager for Node.js.

The development of the frontend is in /static. The project is build with [create-react-app](https://github.com/facebook/create-react-app).

The first time you go in the folder, or anytime you change any module dependancies:
From your project root *cd* to static. The first time you go in the folder, or anytime you change any module dependancies run the following command:
```
$ npm install
```
Expand All @@ -61,7 +37,7 @@ $ npm start
```

The frontend server should be running on localhost:3000! Hit Ctrl+C in the shell to end the server process.
You want the frontend and the backend server running at the same time in different shells.
You want the frontend and the backend server running at the same time in different shells.


## Authors
Expand Down

0 comments on commit dd835a2

Please sign in to comment.