Skip to content

Project Installation Guide

Rey Dekker edited this page Sep 26, 2020 · 3 revisions

Installation guide

To begin with, make sure you have the following versions of npm, and Node

  1. node: v8.16.0 - Feel free to download installer here - https://nodejs.org/en/blog/release/v8.16.0/
  2. npm: 6.4.1 - npm i npm@6.4.1

On every step run the command to check that npm -v, node -v etc.

Navigate to your forked repository using the terminal/shell

Open two(!) windows - one for frontend and one for backend, and do the following:
cd your_path/projects-platform-frontend

yarn

Installs all the needed dependencies.

yarn build

Builds the project.

Add .env file

Ask @nurmerey or @leyla-li for the gist URL for the .env file. Then add it to the root directory. Make sure to setup DATABASE_URL as per instructions in Final Step

✨ Start the backend

yarn server

Runs the backend server on port 5000.

✨ Start the frontend

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.