Skip to content

Installation

Anna edited this page Jan 12, 2021 · 13 revisions

Installation

Back-End

Install backend dependencies.

npm install

  1. Install Mysql. windows linux
  2. Navigate MySQL client =>> for windows
  3. pass your password (you will create this password during installation)
  4. create database voxbox;
  5. check database schema=> show databases; more info
  6. use database voxbox;
  7. create.envfile in root where index.js is located place this in .env file=> DB_HOST=localhost DB_NAME=voxbox DB_USER=yourusername DB_PASSWORD=password JWT_SECRET=123456543212345654321234560987656789OPRTGDQSDFGHJKM

Create .env file to the root with

DB_HOST=YOUR_IP_OR_DOMAIN DB_NAME=YOUR_DATABASE_NAME DB_USER=YOUR_DATABASE_USER DB_PASSWORD=YOUR_DATABASE_USER_PASSWORD JWT_SECRET=A_JWT_SECRET_A_RANDOM_STRING_OF_CHARACTERS

API (Backend)

To develop just the API separately from the frontend run:

npm run dev-api

Database

  • install mysql
  • install sequelize

Front-end

Note: You’ll need to have Node >= 8.10 and npm >= 5.6 on your machine. for everything in client folder to work

Install frontend dependencies

In terminal -global $ curl -o- -L https://yarnpkg.com/install.sh | bash

In client folder

  • $ yarn install --save
  • $ yarn add cross-env
  • $ yarn start

Some of the dependencies for styling

Install these at root/client directory:

  • $ npm i bootstrap

  • $ npm i bootstrap-icons

  • $ npm install react-icons --save

  • $ npm install react-bootstrap-validation --save

  • $ npm install react-bootstrap-sweetalert --save

  • $ npm install --save prop-types

Run:

  • $ yarn add react-bootstrap bootstrap

You might also need to install or run:

  • sass/scc
  • ...

Install these global

npm install redux react-redux -g

To develop just the frontend separately from the API run:

npm run dev-client

Full App

You can also develop the frontend and API in parallel by running:

npm run dev