Skip to content

team3316/kassandra-2019

Repository files navigation

Kassandra

JavaScript Style Guide docstring style dependencies Status devDependencies Status

D-Bug's scouting system, built using React, Redux, Express and Sequelize

Setup

Kassandra is built using Node.js, and uses a PostgreSQL server as its database.

If you want to use a different SQL-based database you need to install the corresponding node module and configure Sequelize accordingly.

Configuration

Make a .env file at the root folder with the same fields as template.env and fill the fields according to your environment.

Deployment

# Clone the repository and change directory
git clone https://github.com/team3316/kassandra-2019.git && cd kassandra-2019
# Install the node dependencies
npm install
# Build the code
npm run build
# Start the server
npm run start

Scripts

npm run lint - Lints the code using ESLint in Standard style

npm run build - Builds the code using Webpack with Babel

npm run watch - Builds the code in watch mode

npm run start - Serves using Express

npm run dev - Starts the server in Nodemon